v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB

Entity Management

Get Entity

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

🗒 Things to Know

This API only supports AI Governance entities (Models, Datasets, AI Systems, and AI Agents).

AI Governance APIs will become available over the course of the Spring as customer tenants are upgraded to enhanced AI Governance services. No customer action is required and more detailed information will be published in upcoming release notes and product documentation.

get/api/ai-governance/v1/entities/{entityId}

Path parameters

entityIdstring uuid required

Identifier of the entity

Query parameters

entityTypeIdstring uuid

Identifier of the entity type

entityTypeNamestring

Name of the entity type

Response

OK - Successfully retrieved the entity 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"
    }
  }
}