Model Management

Get Model Object

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

🗒 Things to Know

  • This API only supports Model objects created via Object Manager.
get/api/custom-entity/v2/models/{entityId}

Request

  • Base URL
    https://hostname/api/custom-entity
  • URL
    https://hostname/api/custom-entity/api/custom-entity/v2/models/{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

The unique identifier of the object.

Response

Model entity details retrieved successfully

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.