Entities

Returns a resolved entity by ID.

Looks up a UUID within the caller's current organization and returns the resource type plus enough context to fetch the canonical resource.

This endpoint is useful when you have an execution, sync, model, Connection, Harbor, Harbor context, Organization, or user UUID and need to determine what it refers to.

The response always includes:

  • id: the UUID that was resolved.
  • type: the resolved entity type.
  • canonical_path: the canonical REST path for the resolved resource.

The response may also include:

  • relationships: parent resources needed to address nested resources.
  • context: lightweight additional context, such as bulk sync schema_ids.

For the normal user-scoped endpoint, organization_id is omitted from the response.

Supported type values currently include:

  • organization
  • user
  • connection
  • model
  • model_sync
  • model_sync_execution
  • bulk_sync
  • bulk_sync_execution
  • harbor
  • harbor_context

Examples:

  • A model sync execution resolves to a model_sync_execution and includes a sync relationship.
  • A bulk sync execution resolves to a bulk_sync_execution, includes a bulk_sync relationship, and may include context.schema_ids.
  • A Harbor context resolves to a harbor_context and includes a harbor relationship.

If the UUID does not exist, or exists outside the caller's scoped organization, the endpoint returns 404.

get/api/entities/{id}

Request

  • Base URL
    https://app.polytomic.com
  • Auth
    • HTTP bearer
    • or HTTP basic

Path parameters

idstring uuid required

UUID of the entity to resolve

Example:248df4b7-aa70-47b8-a036-33ac447e668d

Headers

X-Polytomic-Versionstring

Response

OK

Example response

{
  "data": {
    "canonical_path": "/api/syncs/0ecd09c1-b901-4d27-9053-f0367c427254/executions/8f63fd67-5d47-4cb2-a5fc-e8b933799065",
    "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
    "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
    "type": "model_sync_execution"
  }
}

Changes

    • breaking

      the response's property type changed from object to no type for status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • info

      added to the response property allOf list for the response status