v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB

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}

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 entity.

numberinteger required

The numerical order in which the entity was created.

namestring

The name of the entity.

orgGroupIdstring uuid

The unique identifier of the organization.

schemaIdstring uuid required

The unique identifier of the schema.

attributesobject

Example response

{
  "id": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
  "number": 1,
  "name": "OneTrust",
  "orgGroupId": "d1119953-b4b5-4042-8cb9-b78038cc2c46",
  "entityType": {
    "id": "a2319953-b4b5-4042-8cb9-b78038cc4c46",
    "name": "Asset"
  },
  "workflowAndStage": {
    "id": "b271c01a-89a9-41b1-8185-0a3e2bfdad84",
    "name": "Vendor On-Boarding Workflow",
    "type": "Vendor",
    "workflowMode": "BASIC",
    "stageId": "9fc111cb-c379-4f08-8aff-5be954c1a6e6",
    "stageName": "Start On-Boarding"
  },
  "attributes": {
    "textAttributeName": [
      {
        "value": "Text"
      }
    ],
    "optionBasedAttributeName": [
      {
        "id": "f2229953-b4b5-4042-8cb9-b78038cc4c46"
      }
    ]
  },
  "auditFields": {
    "createdBy": {
      "id": "c21319953-b4b5-4042-8cb9-b78038cc4c51",
      "name": "Name"
    },
    "lastModifiedBy": {
      "id": "c21319953-b4b5-4042-8cb9-b78038cc4c51",
      "name": "Name"
    }
  }
}