Object Management

Get Object

Use this API to retrieve a single object record by its unique identifier along with the associated attributes, module name, and created date.

🗒 Things to Know

  • This API only supports objects created via Object Manager, including Projects, Models, and Datasets.
get/v1/entities/{entityId}

Request

  • Base URL
    https://hostname/api/custom-entity
  • URL
    https://hostname/api/custom-entity/v1/entities/{entityId}
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://{hostname}/api/access/v1/oauth/token scopes: OBJECT_MANAGER, OBJECT_MANAGER_READ, OBJECT_MANAGER_WRITE, INTEGRATION

Path parameters

entityIdstring uuid required

Identifier of the object to retrieve

The unique identifier of the object.

Query parameters

entityTypeIdentifierstring uuid

Identifier of the object type

The unique identifier of the object type.

entityTypeNamestring

Name of the object type

The name of the object type.

Response

OK - Successfully retrieved the object details

idstring uuid required

The unique identifier of the object.

numberinteger required

The sequential order in which the object was created.

namestring required

The name of the object.

orgGroupIdstring uuid

The unique identifier of the organization responsible for the object.

schemaIdstring uuid required

The unique identifier of the schema.

attributesobject

The details of the associated attributes.

Example response

{
  "id": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
  "name": "OneTrust",
  "entityType": {
    "id": "d1119953-b4b5-4042-8cb9-b78038cc2c46",
    "name": "Vendor"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.