> ## 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. # Get Full Entity Details Use this API to retrieve all the details for the specified entity record by key terms and filters. > 🗒 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/search": { "post": { "operationId": "findAllByTypeIdAndCriteriaUsingPOST", "summary": "Get Full Entity Details", "description": "Use this API to retrieve all the details for the specified entity record by key terms and filters.\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": "page", "in": "query", "description": "Results page to be retrieved (0..N). Example: '?page=1'", "schema": { "type": "integer", "default": 0 } }, { "name": "size", "in": "query", "description": "Number of records per page (1..50). Example: '?size=20'", "schema": { "type": "integer", "default": 20, "maximum": 50, "minimum": 1 } }, { "name": "sort", "in": "query", "description": "Sorting criteria in the format: property,(asc|desc). Example: '?sort=name,asc'", "schema": { "type": "string", "default": "name,asc", "enum": [ "name,asc", "name,desc" ] } }, { "name": "entityTypeName", "in": "query", "description": "entityTypeName", "required": false, "schema": { "type": "string" }, "example": "datasets" } ], "requestBody": { "content": { "application/json": { "schema": { "description": "Search parameters including filtering criteria, pagination settings, and sort order", "$ref": "#/components/schemas/EntityListRequest" }, "examples": { "Complex Search Example": { "summary": "Search with multiple conditions", "description": "Example request with multiple search conditions and pagination settings", "value": { "queryRequest": { "criteria": { "fullText": "", "filters": [ { "field": "source", "value": [ "c77e1ae7-ac3f-47ca-b086-6771f10f299d" ], "operator": "EQUAL_TO" }, { "field": "type", "value": [ "f70ed73d-6246-49f7-a197-e87e4fcda125" ], "operator": "EQUAL_TO" } ] } } } } } } } }, "responses": { "200": { "description": "OK - Successfully retrieved matching entities", "content": { "application/json": { "schema": { "description": "Paginated list of detailed entity information matching the search criteria", "$ref": "#/components/schemas/Page" }, "examples": { "DataSets List Response": { "summary": "Paginated list of DataSets", "description": "Example response showing a paginated list of DataSets.", "value": { "content": [ { "attributes": {}, "auditFields": { "createdDate": "2025-11-18T07:46:47.610Z", "lastUpdatedDate": "2025-11-18T09:29:34.233Z", "createdBy": { "id": "5fda0b5e-4eea-4f9f-b512-1e4cae352dbd", "name": "OneTrust User", "email": "b478e00e9f394aff920a688bdc13a491@api.onetrust.com", "initials": "OU" }, "lastModifiedBy": { "id": "e9922cc1-b33b-4a7f-b02a-b0d3645d8e90", "name": "Vinod Ramachandran", "email": "ot-aigov@gmail.com", "initials": "VR" } }, "entityDetail": { "extendedBaseAttributes": { "type": [ { "id": "f70ed73d-6246-49f7-a197-e87e4fcda125", "value": "Time-series", "valueKey": "CE.Datasets.Attribute.Type.Option.Time-seriesDatasets", "disabled": false } ], "source": [ { "id": "c77e1ae7-ac3f-47ca-b086-6771f10f299d", "value": "Cassandra", "valueKey": "CE.Datasets.Attribute.Source.Option.Cassandra", "disabled": false } ] }, "datasetVersion": [ { "id": null, "value": "3", "disabled": false } ], "description": [ { "id": null, "value": "Test Dataset1", "disabled": false } ] }, "entityType": { "id": "f9c55c04-0fd4-44dd-b447-b46af9135341", "name": "datasets", "nameKey": "CE.Datasets.Name", "seeded": true, "moduleName": "AIGovernance", "schemaName": "datasets" }, "id": "ea2586b9-d40a-41c8-808e-2801e33a757d", "name": "Test Dataset1", "number": 9, "orgGroupId": "06e43366-1f49-4afd-8c51-3989f9cf98f1", "schemaId": "b9c8145e-1431-46f5-922d-2137f0636485", "workflowAndStage": null } ], "pageable": { "pageNumber": 0, "pageSize": 10, "sort": { "empty": false, "sorted": true, "unsorted": false }, "offset": 0, "paged": true, "unpaged": false }, "last": true, "totalElements": 1, "totalPages": 1, "size": 10, "number": 0, "sort": { "empty": false, "sorted": true, "unsorted": false }, "first": true, "numberOfElements": 1, "empty": false } } } } } }, "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_READ", "AI_GOVERNANCE_WRITE" ] } ] } } }, "components": { "schemas": { "Page": { "type": "object", "properties": { "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" }, "size": { "type": "integer", "format": "int32" }, "content": { "items": { "type": "object" }, "type": "array" }, "number": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "first": { "type": "boolean" }, "last": { "type": "boolean" }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "numberOfElements": { "type": "integer", "format": "int32" }, "empty": { "type": "boolean" } } }, "PageableObject": { "type": "object", "properties": { "offset": { "type": "integer", "format": "int64" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "paged": { "type": "boolean" }, "pageSize": { "type": "integer", "format": "int32" }, "pageNumber": { "type": "integer", "format": "int32" }, "unpaged": { "type": "boolean" } } }, "SortObject": { "type": "object", "properties": { "empty": { "type": "boolean" }, "sorted": { "type": "boolean" }, "unsorted": { "type": "boolean" } } }, "AttributePredicate": { "type": "object", "properties": { "field": { "description": "The field name used to filter results.", "type": "string" }, "operator": { "description": "The relationship that must be met between the field and value.", "type": "string", "enum": [ "EQUAL_TO", "NOT_EQUAL_TO", "GREATER_THAN", "GREATER_THAN_EQUAL_TO", "LESS_THAN", "LESS_THAN_EQUAL_TO", "BETWEEN" ] }, "value": { "description": "The field value used to filter results. If filtering for a range of values, this would be the start of the range and should be used in conjunction with the `toValue` parameter. \nExamples by type: UUID = 'e68d49c4-f11f-4cd9-8f1b-0be8ef945b8f', LocalDate = '2023-01-01', OffsetDateTime = '2023-01-01T00:00:00Z', String = 'Closed', Number = 7", "type": "object", "oneOf": [ { "type": "string", "format": "uuid" }, { "type": "string", "format": "date" }, { "type": "string", "format": "date-time" }, { "type": "string" }, { "type": "number" } ] }, "toValue": { "description": "The field value for the end of the range. This field should be used in conjunction with the `value` parameter. \nExamples by type: LocalDate = '2023-01-01', OffsetDateTime = '2023-01-01T00:00:00Z', String = 'Closed', Number = 7", "type": "object", "oneOf": [ { "type": "string", "format": "date" }, { "type": "string", "format": "date-time" }, { "type": "string" }, { "type": "number" } ] } }, "required": [ "field" ] }, "AttributeQueryCriteria": { "type": "object", "properties": { "filters": { "description": "The fields and values used to filter results.", "type": "array", "items": { "$ref": "#/components/schemas/AttributePredicate" }, "uniqueItems": true }, "fullText": { "description": "The key terms for the search criteria.", "type": "string", "maxLength": 500, "minLength": 0 } } }, "EntityQueryRequest": { "type": "object", "properties": { "criteria": { "description": "The criteria used to search for entities, including filters, full-text search, and sorting", "example": { "filters": [ { "fieldName": "name", "operator": "contains", "value": "OneTrust" } ], "searchQuery": "privacy", "sort": [ { "fieldName": "lastModifiedTimestamp", "direction": "DESC" } ] }, "$ref": "#/components/schemas/AttributeQueryCriteria" }, "organizationTraversalStrategy": { "description": "The strategy for fetching entities across related organizations. Default: null (no organization traversal applicable)", "type": "string", "example": "ancestors_and_descendants", "enum": [ "ancestors_and_descendants", "descendants", "all" ] }, "requestedOrganizationId": { "description": "The overridden requested organization identifier. If supplied, would be used instead of request context organization", "type": "string", "format": "uuid", "example": "f2229953-b4b5-4042-8cb9-b78038cc4c46" }, "queryAction": { "description": "The query action specifies the source of the API call and allows a service to apply a predicate", "type": "string", "example": "ListEntity" } }, "example": { "criteria": { "filters": [ { "fieldName": "name", "operator": "contains", "value": "OneTrust" }, { "fieldName": "entityStatus", "operator": "equals", "value": "Active" }, { "fieldName": "lastModifiedTimestamp", "operator": "greaterThan", "value": "2024-01-01T00:00:00Z" } ], "searchQuery": "privacy", "sort": [ { "fieldName": "lastModifiedTimestamp", "direction": "DESC" } ] }, "organizationTraversalStrategy": "ancestors_and_descendants", "requestedOrganizationId": "f2229953-b4b5-4042-8cb9-b78038cc4c46", "queryAction": "ListEntity" } }, "ContextInformation": { "type": "object", "properties": { "parameters": { "additionalProperties": { "type": "object" }, "type": "object" } } }, "EntityFieldRequest": { "type": "object", "properties": { "fields": { "description": "The requested non-base fields.", "type": "array", "items": { "type": "string" }, "example": [ "textAttributeField1", "singleSelectAttributeField1" ], "maxItems": 500, "minItems": 0 }, "mode": { "description": "The mode based on which required non-base fields would be selected.", "type": "string", "default": "select_all", "enum": [ "select_all", "ignore_all", "specific" ], "minLength": 1 }, "includeSelectedFullTextSearchFields": { "description": "The full text search mode would only includes passed \"fields\" of Text/Date/NumericalText/DateTime response type.", "type": "boolean", "example": true }, "overriddenSearchFields": { "description": "The caller can override search (system) fields which need to included.", "type": "array", "items": { "type": "string" }, "example": [ "name" ] } } }, "EntityListRequest": { "type": "object", "properties": { "context": { "description": "User-defined context for the current request", "$ref": "#/components/schemas/ContextInformation" }, "queryRequest": { "description": "Query request containing search criteria and organization context", "$ref": "#/components/schemas/EntityQueryRequest" }, "requestedFields": { "description": "Field request specifying which fields to include in the response", "$ref": "#/components/schemas/EntityFieldRequest" } }, "example": { "queryRequest": { "criteria": { "filters": [ { "fieldName": "name", "operator": "contains", "value": "OneTrust" }, { "fieldName": "entityStatus", "operator": "equals", "value": "Active" } ], "searchQuery": "gdpr", "sort": [ { "fieldName": "lastModifiedTimestamp", "direction": "DESC" } ] }, "organizationTraversalStrategy": "ancestors_and_descendants", "requestedOrganizationId": "f2229953-b4b5-4042-8cb9-b78038cc4c46", "queryAction": "ListEntity" }, "requestedFields": { "includeStandardFields": true, "includeCustomFields": true, "includeAuditFields": false, "specificStandardFields": [ "name", "entityNumber", "createdBy" ], "specificCustomFields": [ "vendor_tier", "risk_score" ] } } } }, "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" } } } } } } } ```