Get Entity
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 syncschema_ids.
For the normal user-scoped endpoint, organization_id is omitted from the
response.
Supported type values currently include:
organizationuserconnectionmodelmodel_syncmodel_sync_executionbulk_syncbulk_sync_executionharborharbor_context
Examples:
- A model sync execution resolves to a
model_sync_executionand includes asyncrelationship. - A bulk sync execution resolves to a
bulk_sync_execution, includes abulk_syncrelationship, and may includecontext.schema_ids. - A Harbor context resolves to a
harbor_contextand includes aharborrelationship.
If the UUID does not exist, or exists outside the caller’s scoped
organization, the endpoint returns 404.
Authentication
AuthorizationBearer
Bearer user API key
OR
AuthorizationBasic
Basic organization-scoped API key
Path parameters
id
UUID of the entity to resolve.
Headers
X-Polytomic-Version
Response
OK
data
Errors
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error
