v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB

Object Type Management

Get Object Type by Name

Use this API to retrieve details for the object type by its name. The response will return the user who created the object type, created date, and description.

🗒 Things to Know

This API only supports objects created via Object Manager, including Projects, Models, and Datasets.

get/v1/entity-types/names/{entityTypeName}

Path parameters

entityTypeNamestring required

Name of the object type to retrieve. Can be used instead of entityTypeId.

The name of the object type.

Response

OK - Returns the complete details of the requested object 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"
  }
}