> ## Documentation Index
> Fetch the complete documentation index at: https://developer.onetrust.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Modify Entity

Use this API to partially update an existing entity record.

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

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "AI Governance - AI Governance",
    "version": "1.0",
    "contact": {
      "name": "OneTrust Support",
      "url": "https://my.onetrust.com/s/contactsupport"
    },
    "license": {
      "name": "Apache 2.0",
      "url": "https://www.apache.org/licenses/LICENSE-2.0"
    },
    "description": "The AI Governance APIs are used to integrate external systems and streamline the flow of data with AI Governance in the OneTrust Platform."
  },
  "servers": [
    {
      "url": "https://{hostname}",
      "variables": {
        "hostname": {
          "default": "hostname",
          "description": "The OneTrust hostname such as app.onetrust.com, app-eu.onetrust.com, app-de.onetrust.com, app-uk.onetrust.com, app-apac.onetrust.com, trial.onetrust.com, or uat.onetrust.com."
        }
      }
    }
  ],
  "tags": [
    {
      "name": "Entity Management",
      "description": "The Entity Management APIs are used to manage AI Governance entities.",
      "externalDocs": {
        "description": "OpenAPI 3.1.0 - Download Definition",
        "url": "https://developer.onetrust.com/onetrust/openapi/ai-governance.json"
      }
    }
  ],
  "x-onetrust": {
    "spec-label": "OpenAPI 3.1.0"
  },
  "x-readme": {
    "explorer-enabled": false,
    "proxy-enabled": false,
    "metrics-enabled": false
  },
  "paths": {
    "/api/ai-governance/v1/entities/{entityId}": {
      "patch": {
        "operationId": "updateUsingEntityTypeIdOrEntityTypeNameUsingPATCH",
        "summary": "Modify Entity",
        "description": "Use this API to partially update an existing entity record.\n\n> 🗒 Things to Know\n> \n> - This API only supports AI Governance entities (Models, Datasets, AI Systems, and AI Agents).\n> - 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. ",
        "tags": [
          "Entity Management"
        ],
        "x-onetrust": {
          "spec-label": "https://developer.onetrust.com/onetrust/openapi/ai-governance.json"
        },
        "parameters": [
          {
            "name": "entityTypeId",
            "in": "query",
            "description": "Identifier of the entity type",
            "required": false,
            "schema": {
              "type": "string",
              "format": "uuid"
            },
            "example": "2aa71ead-0c9a-416a-8471-bdfb67c8d113"
          },
          {
            "name": "entityTypeName",
            "in": "query",
            "description": "Name of the entity type",
            "required": false,
            "schema": {
              "type": "string"
            },
            "example": "datasets"
          },
          {
            "name": "entityId",
            "in": "path",
            "description": "Entity Identifier",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            },
            "example": "f04d40dc-f0be-4671-a604-4755f40d2f0b"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "description": "Entity update request containing the fields to be modified",
                "$ref": "#/components/schemas/EntityUpdateRequest"
              },
              "examples": {
                "Update dataset Example": {
                  "summary": "Update dataset",
                  "description": "Example request to update a dataset",
                  "value": {
                    "id": "ea2586b9-d40a-41c8-808e-2801e33a757d",
                    "number": 9,
                    "name": "Test Dataset1",
                    "organization": {
                      "id": "06e43366-1f49-4afd-8c51-3989f9cf98f1",
                      "name": "AIGovernance-New"
                    },
                    "schemaId": "b9c8145e-1431-46f5-922d-2137f0636485",
                    "entityType": {
                      "id": "f9c55c04-0fd4-44dd-b447-b46af9135341",
                      "name": "datasets",
                      "nameKey": "CE.Datasets.Name",
                      "seeded": true,
                      "moduleName": "AIGovernance",
                      "schemaName": "datasets"
                    },
                    "createdDate": "2025-11-18T07:46:47.610Z",
                    "lastModifiedDate": "2025-11-18T09:18:24.646Z",
                    "createdBy": [
                      {
                        "id": "5fda0b5e-4eea-4f9f-b512-1e4cae352dbd",
                        "value": "OneTrust User",
                        "disabled": false
                      }
                    ],
                    "lastModifiedBy": [
                      {
                        "id": "e9922cc1-b33b-4a7f-b02a-b0d3645d8e90",
                        "value": "Vinod Ramachandran",
                        "disabled": false
                      }
                    ],
                    "canViewDetails": [
                      {
                        "id": null,
                        "value": "true",
                        "disabled": false
                      }
                    ],
                    "type": [
                      {
                        "id": "a8098fb2-2bbf-4d71-a07e-4c261f55b89a",
                        "value": "Audio",
                        "valueKey": "CE.Datasets.Attribute.Type.Option.AudioDatasets",
                        "disabled": false
                      }
                    ],
                    "datasetVersion": [
                      {
                        "id": null,
                        "value": "3",
                        "disabled": false
                      }
                    ],
                    "description": [
                      {
                        "id": null,
                        "value": "Test Dataset1",
                        "disabled": false
                      }
                    ]
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK - The entity was successfully updated",
            "content": {
              "application/json": {
                "schema": {
                  "description": "Complete information about the updated entity",
                  "$ref": "#/components/schemas/EntityInformation"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request"
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "Forbidden"
          },
          "429": {
            "description": "Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).",
            "headers": {
              "Retry-After": {
                "schema": {
                  "description": "The number of seconds after which requests will be allowed again.",
                  "format": "int32"
                }
              },
              "ot-period": {
                "schema": {
                  "description": "The unit of time for which the rate limit applies",
                  "enum": [
                    "HOUR",
                    "MINUTE"
                  ]
                }
              },
              "ot-ratelimit-event-id": {
                "schema": {
                  "description": "The unique identifier for the rate-limiting event.",
                  "format": "uuid"
                }
              },
              "ot-request-made": {
                "schema": {
                  "description": "The number of requests made within the specified period.",
                  "format": "int32"
                }
              },
              "ot-requests-allowed": {
                "schema": {
                  "description": "The number of requests allowed within the specified period.",
                  "format": "int32"
                }
              }
            }
          },
          "500": {
            "description": "Internal Server Error"
          }
        },
        "security": [
          {
            "OAUTH2": [
              "AI_GOVERNANCE",
              "AI_GOVERNANCE_WRITE"
            ]
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "AssociatedAttributeValueInformation": {
        "type": "object",
        "properties": {
          "id": {
            "description": "Unique identifier for the attribute option",
            "type": "string",
            "format": "uuid",
            "example": "a34ccec7-1ec0-4d65-9075-bdd0d923f1d1"
          },
          "value": {
            "description": "Attribute value",
            "type": "string",
            "example": "Text Value"
          },
          "valueKey": {
            "description": "Translation key used for localizing the value",
            "type": "string",
            "example": "attribute.option.valueKey"
          },
          "colorCode": {
            "description": "Color code associated with the option. Used for score-based attributes.",
            "type": "string",
            "example": "red"
          }
        },
        "required": [
          "value"
        ]
      },
      "AttributeValueInformation": {
        "type": "object",
        "properties": {
          "id": {
            "description": "Unique identifier for the attribute option",
            "type": "string",
            "format": "uuid",
            "example": "a34ccec7-1ec0-4d65-9075-bdd0d923f1d1"
          },
          "value": {
            "description": "Attribute value",
            "type": "string",
            "example": "Text Value"
          },
          "valueKey": {
            "description": "Translation key used for localizing the value",
            "type": "string",
            "example": "attribute.option.valueKey"
          },
          "colorCode": {
            "description": "Color code associated with the option. Used for score-based attributes.",
            "type": "string",
            "example": "red"
          },
          "optionSelectionValue": {
            "description": "Selection score value linked to the option. Used for score-based or numerical-based attributes.",
            "type": "string",
            "example": "3.5"
          },
          "displayLabel": {
            "description": "Display name for the option, used for external attributes managed by other systems",
            "type": "string",
            "example": "United State | San Francisco"
          },
          "associatedAttributeValueInformation": {
            "description": "Associated attribute option information",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AssociatedAttributeValueInformation"
            }
          },
          "disabled": {
            "description": "Indicates whether this attribute option is currently disabled.",
            "type": "boolean",
            "example": false,
            "default": "false"
          }
        },
        "required": [
          "value"
        ]
      },
      "BasicEntityTypeInformation": {
        "type": "object",
        "properties": {
          "id": {
            "description": "The unique identifier for the entity type.",
            "type": "string",
            "format": "uuid",
            "example": "f2229953-b4b5-4042-8cb9-b78038cc4c46"
          },
          "name": {
            "description": "The name of the entity type.",
            "type": "string",
            "example": "Vendor"
          },
          "seeded": {
            "description": "This parameter indicates whether the entity type is seeded or custom.",
            "type": "boolean",
            "example": true
          },
          "moduleName": {
            "description": "The name of the module where the entity exists.",
            "type": "string",
            "example": "Vendor",
            "enum": [
              "Vendor",
              "DataMapping",
              "Risk",
              "Assessments",
              "CustomEntityManagement"
            ]
          },
          "schemaName": {
            "description": "The name of the schema.",
            "type": "string",
            "example": "vendor",
            "enum": [
              "vendor",
              "projects",
              "models",
              "datasets",
              "aisystems"
            ]
          }
        },
        "example": "{\n \"id\": \"f2229953-b4b5-4042-8cb9-b78038cc4c46\",\n \"name\": \"Vendor\",\n \"nameKey\": \"EntityType.Vendor.Name\",\n \"seeded\": true,\n \"moduleName\": \"Vendor\",\n \"schemaName\": \"vendor\"\n},\n",
        "required": [
          "id",
          "name"
        ]
      },
      "EntityBasicUserInformation": {
        "type": "object",
        "properties": {
          "id": {
            "description": "The unique identifier of the user.",
            "type": "string",
            "format": "uuid",
            "example": "f2229953-b4b5-4042-8cb9-b78038cc4c46"
          },
          "name": {
            "description": "The full name of the user.",
            "type": "string",
            "example": "First Last"
          },
          "email": {
            "description": "The email address of the user.",
            "type": "string",
            "example": "user@gmail.com"
          },
          "initials": {
            "description": "The initials for the first and last name of the user.",
            "type": "string",
            "example": "FL"
          }
        }
      },
      "EntityRecordAuditInformation": {
        "type": "object",
        "properties": {
          "createdDate": {
            "description": "The date and time that the entity was last created.",
            "type": "string",
            "format": "date-time",
            "example": "2021-05-13T13:06:49.853Z"
          },
          "lastUpdatedDate": {
            "description": "The date and time that the entity was last updated.",
            "type": "string",
            "format": "date-time",
            "example": "2021-05-13T13:06:49.853Z"
          },
          "createdBy": {
            "description": "The information of the user who last created/modified the entity.",
            "example": {
              "id": "c21319953-b4b5-4042-8cb9-b78038cc4c51",
              "name": "Name"
            },
            "$ref": "#/components/schemas/EntityBasicUserInformation"
          },
          "lastModifiedBy": {
            "description": "The information of the user who last created/modified the entity.",
            "example": {
              "id": "c21319953-b4b5-4042-8cb9-b78038cc4c51",
              "name": "Name"
            },
            "$ref": "#/components/schemas/EntityBasicUserInformation"
          }
        },
        "required": [
          "createdDate"
        ]
      },
      "EntityOrganizationInformation": {
        "type": "object",
        "properties": {
          "id": {
            "description": "The unique identifier of the organization.",
            "type": "string",
            "format": "uuid",
            "example": "f2229953-b4b5-4042-8cb9-b78038cc4c46"
          },
          "name": {
            "description": "The name of the organization.",
            "type": "string",
            "example": "Business Unit"
          }
        },
        "required": [
          "id"
        ]
      },
      "EntityInformation": {
        "type": "object",
        "properties": {
          "id": {
            "description": "The unique identifier of the entity. Auto-generated when a new entity is created.",
            "type": "string",
            "format": "uuid",
            "example": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
            "readOnly": true
          },
          "number": {
            "description": "The numerical order in which the entity was created. Used for reference and sorting.",
            "type": "integer",
            "format": "int64",
            "example": 1,
            "maximum": 9999999,
            "minimum": 1,
            "readOnly": true
          },
          "name": {
            "description": "The name of the entity. Used as the primary identifier for users.",
            "type": "string",
            "example": "OneTrust",
            "maxLength": 255,
            "minLength": 1
          },
          "orgGroupId": {
            "description": "The unique identifier of the organization that owns this entity.",
            "type": "string",
            "format": "uuid",
            "example": "d1119953-b4b5-4042-8cb9-b78038cc2c46"
          },
          "schemaId": {
            "description": "The unique identifier of the schema that defines the structure of this entity.",
            "type": "string",
            "format": "uuid",
            "example": "c21319953-b4b5-4042-8cb9-b78038cc4c51",
            "readOnly": true
          },
          "entityType": {
            "description": "The parameters that detail the type of entity, including type ID, name and other type-specific information.",
            "example": {
              "id": "a2319953-b4b5-4042-8cb9-b78038cc4c46",
              "name": "Asset"
            },
            "$ref": "#/components/schemas/BasicEntityTypeInformation"
          },
          "workflowAndStage": {
            "description": "The parameters that detail the workflow and stage information, including current workflow state and stage details.",
            "example": {
              "id": "b271c01a-89a9-41b1-8185-0a3e2bfdad84",
              "name": "Vendor On-Boarding Workflow",
              "nameKey": "Workflow.VendorOnBoarding.Name",
              "type": "Vendor",
              "workflowMode": "BASIC",
              "stageId": "9fc111cb-c379-4f08-8aff-5be954c1a6e6",
              "stageName": "Start On-Boarding",
              "stageNameKey": "Workflow.VendorOnBoarding.Stage.StartOnBoarding",
              "badgeColor": "#4287f5"
            },
            "$ref": "#/components/schemas/EntityWorkflowInformation"
          },
          "attributes": {
            "description": "The custom attributes of the entity defined by the entity type schema. Contains attribute paths and corresponding values. The number of attributes can vary based on the entity type definition.",
            "type": "object",
            "example": {
              "textAttributeName": [
                {
                  "value": "Text"
                }
              ],
              "optionBasedAttributeName": [
                {
                  "id": "f2229953-b4b5-4042-8cb9-b78038cc4c46"
                }
              ]
            },
            "additionalProperties": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/AttributeValueInformation"
              }
            }
          },
          "auditFields": {
            "description": "The parameters that provide audit history for the entity, including creation and modification details.",
            "example": {
              "createdBy": "admin@example.com",
              "createdTimestamp": "2023-01-15T10:30:45Z",
              "lastModifiedBy": "system@example.com",
              "lastModifiedTimestamp": "2025-03-22T14:15:22Z"
            },
            "$ref": "#/components/schemas/EntityRecordAuditInformation",
            "readOnly": true
          }
        },
        "example": {
          "id": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
          "name": "OneTrust",
          "entityType": {
            "id": "d1119953-b4b5-4042-8cb9-b78038cc2c46",
            "name": "Vendor"
          }
        },
        "required": [
          "entityType",
          "id",
          "name",
          "number",
          "schemaId"
        ],
        "title": "Entity Information"
      },
      "EntityWorkflowInformation": {
        "type": "object",
        "properties": {
          "id": {
            "description": "The unique identifier of the workflow.",
            "type": "string",
            "format": "uuid",
            "example": "b271c01a-89a9-41b1-8185-0a3e2bfdad84"
          },
          "name": {
            "description": "The name of the workflow.",
            "type": "string",
            "example": "Vendor On-Boarding Workflow"
          },
          "type": {
            "description": "The type of workflow.",
            "type": "string",
            "example": "Vendor"
          },
          "workflowMode": {
            "description": "This parameter indicates whether the workflow mode is null, basic, or advanced.",
            "type": "string",
            "example": "BASIC",
            "enum": [
              "ADVANCED, BASIC"
            ]
          },
          "stageId": {
            "description": "The unique identifier of the workflow stage.",
            "type": "string",
            "format": "uuid",
            "example": "9fc111cb-c379-4f08-8aff-5be954c1a6e6"
          },
          "stageName": {
            "description": "The name of the workflow stage.",
            "type": "string",
            "example": "Start On-Boarding"
          }
        },
        "example": {
          "id": "b271c01a-89a9-41b1-8185-0a3e2bfdad84",
          "name": "Vendor On-Boarding Workflow",
          "nameKey": "Workflow.VendorOnBoarding.Name",
          "type": "Vendor",
          "workflowMode": "BASIC",
          "stageId": "9fc111cb-c379-4f08-8aff-5be954c1a6e6",
          "stageName": "Start On-Boarding",
          "stageNameKey": "Workflow.VendorOnBoarding.Stage.StartOnBoarding",
          "badgeColor": "#4287f5"
        },
        "required": [
          "id",
          "name",
          "stageId",
          "stageName",
          "type"
        ]
      },
      "EntityUpdateRequest": {
        "type": "object",
        "properties": {
          "name": {
            "description": "The updated name of the entity. If not provided, the existing name will be retained.",
            "type": "string",
            "example": "OneTrust",
            "maxLength": 255,
            "minLength": 1
          },
          "organization": {
            "description": "The updated organization group for the entity. Contains organization ID and optional name. If not provided, the existing organization will be retained.",
            "example": {
              "id": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
              "name": "Business Unit"
            },
            "$ref": "#/components/schemas/EntityOrganizationInformation"
          },
          "attributes": {
            "description": "Custom attributes to update on the entity. Only the attributes provided will be updated; others will retain their existing values.",
            "type": "object",
            "example": {
              "textAttributeName": [
                {
                  "value": "Text"
                }
              ],
              "optionBasedAttributeName": [
                {
                  "id": "f2229953-b4b5-4042-8cb9-b78038cc4c46"
                }
              ]
            },
            "additionalProperties": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/AttributeValueInformation"
              }
            }
          }
        },
        "example": {
          "name": "OneTrust Updated",
          "attributes": {
            "textAttributeName": [
              {
                "value": "New Text Value"
              }
            ]
          }
        },
        "title": "Entity Update Request"
      }
    },
    "securitySchemes": {
      "OAUTH2": {
        "type": "oauth2",
        "flows": {
          "clientCredentials": {
            "tokenUrl": "https://{hostname}/api/access/v1/oauth/token",
            "scopes": {
              "AI_GOVERNANCE": "Grants full permissions to manage AI Governance operations for external systems",
              "AI_GOVERNANCE_READ": "Allows read-only access to AI Governance entities",
              "AI_GOVERNANCE_WRITE": "Grants permissions to create and modify AI Governance entities"
            }
          }
        }
      }
    }
  }
}
```