v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB

Entity Type Management

Get Entity Type

Use this API to retrieve the details for the specified entity type. The response will return the user who created the entity type, created date, and description.

🗒 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/entity-types/{entityTypeId}

Path parameters

entityTypeIdstring uuid required

Entity type Identifier

The unique identifier of the entity type.

Response

OK - Returns the complete details of the requested entity type

idstring uuid required

The unique identifier for the entity type.

namestring required

The name of the entity type.

seededboolean

This parameter indicates whether the entity type is seeded or custom.

moduleName'Vendor' | 'DataMapping' | 'Risk' | 'Assessments' | 'CustomEntityManagement'

The name of the module where the entity exists.

schemaName'vendor' | 'projects' | 'models' | 'datasets' | 'aisystems'

The name of the schema.

descriptionstring

Description of the entity type

descriptionKeystring

Translation key for the description

workflowTypestring

Workflow type associated with the entity type

enabledboolean

Flag indicating whether the entity type is enabled

moduleScopesstring[]

Module scopes for the entity type

Example response

{
  "id": "789e4567-e89b-12d3-a456-426614174123",
  "name": "Vendor",
  "nameKey": "entity.type.vendor",
  "displayName": "Vendor",
  "displayNameKey": "entity.type.vendor.display",
  "module": "VENDOR",
  "description": "A third-party organization that provides goods or services to the company",
  "descriptionKey": "entity.type.vendor.description",
  "workflowType": "vendor_assessment",
  "enabled": true,
  "moduleScopes": [
    "Inventory",
    "VRM",
    "Security"
  ],
  "settings": {
    "enableSearch": true,
    "enableQuickCreate": true,
    "enableExtendedAttributes": true,
    "enableDuplicateDetection": true,
    "workflowEnabled": true,
    "auditEnabled": true
  },
  "auditFields": {
    "createdBy": "admin@example.com",
    "createdTimestamp": "2023-01-15T10:30:45Z",
    "lastModifiedBy": "system@example.com",
    "lastModifiedTimestamp": "2025-03-22T14:15:22Z"
  }
}