v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB

Object Type Management

Modify Custom Object Type by Name

Use this API to partially update an existing object type by its name.

🗒 Things to Know

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

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

Path parameters

entityTypeNamestring required

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

The name of the object type.

Request body

namestring

The name of the object type.

descriptionstring

The description of the object type.

moduleScopesstring[]

The product scopes of the object type.

Example request

{
  "name": "Vendor",
  "description": "Module.VendorsNameKey",
  "moduleScopes": [
    "Inventory",
    "VRM",
    "Assessments",
    "IssueManagement"
  ],
  "settings": {
    "enableWorkflow": true
  },
  "workflow": {
    "name": "Default Vendor On-Boarding",
    "description": "Default Vendor On-Boarding For New Vendors",
    "stages": [
      {
        "name": "Document Review Stage",
        "nameKey": "Workflow.DocumentReview.Stage.Review",
        "description": "Stage for reviewing and approving documents",
        "descriptionKey": "Workflow.DocumentReview.Stage.Review.Description",
        "allowDeletion": true,
        "badgeColor": "#4287f5",
        "approvalStage": true,
        "exceptionStage": false,
        "autoAdvanceOnApproval": true,
        "subTasks": [
          {
            "name": "Initial Review",
            "description": "Perform initial document review",
            "required": true
          }
        ],
        "stageApprovers": [
          {
            "approverId": "123e4567-e89b-12d3-a456-426614174000",
            "approverType": "USER",
            "required": true
          }
        ],
        "stageExceptionConfiguration": {
          "allowExceptions": true,
          "exceptionApprovers": [
            "456e7890-e89b-12d3-a456-426614174000"
          ]
        },
        "additionalFields": {
          "priority": "HIGH",
          "department": "Legal",
          "estimatedDuration": 48
        },
        "advanceStageActionEnabled": true,
        "advanceStageActions": [
          {
            "actionType": "ATTRIBUTES",
            "actionMetadata": {
              "fieldName": "value"
            }
          }
        ]
      }
    ]
  }
}

Response

OK - The object type was successfully updated

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"
  }
}