Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1440296193.3 KB

Retrieves information about an entity.

get/workspaces/{workspaceId}/entities/{entityId}

Path parameters

workspaceIdstring required

The ID of the workspace.

entityIdstring required

The ID of the entity.

Response

Success

entityIdstring required

The ID of the entity.

entityNamestring required

The name of the entity.

arnstring required

The ARN of the entity.

workspaceIdstring required

The ID of the workspace.

descriptionstring

The description of the entity.

componentsobject

An object that maps strings to the components in the entity. Each string in the mapping must be unique to this object.

parentEntityIdstring required

The ID of the parent entity for this entity.

hasChildEntitiesboolean required

A Boolean value that specifies whether the entity has associated child entities.

creationDateTimestring date-time required

The date and time when the entity was created.

updateDateTimestring date-time required

The date and time when the entity was last updated.

syncSourcestring

The syncSource of the sync job, if this entity was created by a sync job.

areAllComponentsReturnedboolean

This flag notes whether all components are returned in the API response. The maximum number of components returned is 30.