OneTrust AI Governance — AI Governance

{"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":"Attribute Management","description":"The Attribute Management APIs are used to manage attributes associated with AI Governance entities.","externalDocs":{"description":"OpenAPI 3.1.0 - Download Definition","url":"https://developer.onetrust.com/onetrust/openapi/ai-governance.json"}},{"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"}},{"name":"Entity Type Management","description":"The Entity Type Management APIs are used to manage AI Governance entity types.","externalDocs":{"description":"OpenAPI 3.1.0 - Download Definition","url":"https://developer.onetrust.com/onetrust/openapi/ai-governance.json"}},{"name":"Entity Workflow Management","description":"The Entity Workflow Management APIs are used to manage AI Governance entity workflows.","externalDocs":{"description":"OpenAPI 3.1.0 - Download Definition","url":"https://developer.onetrust.com/onetrust/openapi/ai-governance.json"}},{"name":"Relationship Management","description":"The Relationship Management APIs are used to manage relationships between AI Governance entities.","externalDocs":{"description":"OpenAPI 3.1.0 - Download Definition","url":"https://developer.onetrust.com/onetrust/openapi/ai-governance.json"}},{"name":"Task Management","description":"The Task Management APIs are used to manage tasks associated with 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/assignments/entities/{entityId}/types/{type}/stage":{"post":{"operationId":"assignStageByName","summary":"Update Entity Workflow Stage","description":"Use this API to update the workflow stage for the specified 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 Workflow Management"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/ai-governance.json"},"parameters":[{"name":"entityId","in":"path","description":"Identifier of the entity","required":true,"schema":{"description":"Identifier of the entity","type":"string","format":"uuid"},"example":"f7114aef-b6b6-42d6-9249-56a467950aa7"},{"name":"type","in":"path","description":"Workflow Type","required":true,"schema":{"description":"Workflow type Name","type":"string","format":"uuid"},"example":"3933259d-fc21-41e2-b511-18c11cedf938"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"example":{"nextStageName":"Remediating","parameters":{"executeRule":true}},"$ref":"#/components/schemas/WorkflowSpecificStageNavigationRequest"}}}},"responses":{"200":{"description":"Successfully assigned the workflow stage.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowStageListInformation"}}}},"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"]}]}},"/api/ai-governance/v1/entities":{"post":{"operationId":"addEntityUsingEntityTypeIdOrEntityTypeNameUsingPOST","summary":"Create Entity","description":"Use this API to create a new 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"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityCreateRequest"},"examples":{"Create dataset Example":{"summary":"Create a dataset","description":"Example request to create a dataset with attributes","value":{"name":"Test Dataset","attributes":{"description":[{"value":"Test Dataset2"}],"owner":[]},"organization":{"id":"06e43366-1f49-4afd-8c51-3989f9cf98f1"}}}}}}},"responses":{"201":{"description":"Created - The entity was successfully created","content":{"application/json":{"schema":{"description":"Complete information about the created entity","$ref":"#/components/schemas/EntityInformation"},"examples":{"Created DataSet Response":{"summary":"Response for created DataSet","description":"Example response after successfully creating a DataSet","value":{"id":"0ed3f38b-31ac-45f5-9f85-750214217387","number":10,"name":"Test Dataset","orgGroupId":"06e43366-1f49-4afd-8c51-3989f9cf98f1","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"},"workflowAndStage":null,"entityDetail":{"description":[{"id":null,"value":"Test Dataset2","disabled":false}]},"attributes":{},"auditFields":{"createdDate":"2025-11-18T08:54:42.017Z","lastUpdatedDate":"2025-11-18T08:54:42.017Z","createdBy":{"id":"5fda0b5e-4eea-4f9f-b512-1e4cae352dbd","name":"OneTrust User","email":"b478e00e9f394aff920a688bdc13a491@api.onetrust.com","initials":"OU"},"lastModifiedBy":{"id":"5fda0b5e-4eea-4f9f-b512-1e4cae352dbd","name":"OneTrust User","email":"b478e00e9f394aff920a688bdc13a491@api.onetrust.com","initials":"OU"}}}}}}}},"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"]}]}},"/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"]}]}},"/api/ai-governance/v1/entities/{entityId}":{"get":{"operationId":"getEntityInformationUsingEntityTypeIdOrEntityTypeNameUsingGET","summary":"Get Entity","description":"Use this API to retrieve a single entity record by its unique identifier along with the associated attributes, module name, and created date.\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":"Identifier of the entity","required":true,"schema":{"type":"string","format":"uuid"},"example":"b2ce12f5-841d-47aa-8d72-8e1d47237806"}],"responses":{"200":{"description":"OK - Successfully retrieved the entity details","content":{"application/json":{"schema":{"description":"Complete information about the requested entity","$ref":"#/components/schemas/EntityInformation"},"examples":{"Dataset Details":{"summary":"Detailed information about a dataset","description":"Example response containing full details of a dataset","value":{"id":"a6a65501-2d42-4ddc-92a1-d8ef52f4e4a8","number":1,"name":"Aigov Dataset","orgGroupId":"2b5e1bbd-efbf-42e5-b0d9-2656e4266e25","schemaId":"61d99b0d-e980-4339-ac90-2bb21d63da88","entityType":{"id":"2ed963ac-1049-4084-88f2-abfecab8eb3a","name":"datasets","nameKey":"CE.Datasets.Name","seeded":true,"moduleName":"AIGovernance","schemaName":"datasets"},"workflowAndStage":null,"entityDetail":{"extendedBaseAttributes":{"function":[{"id":"44a91874-1eee-4a4b-881c-16f6032766f1","value":"Testing","valueKey":"CE.Datasets.Attribute.Function.Option.Testing","disabled":false}]},"annotation":[{"id":null,"value":"Annotation 1.2","disabled":false}],"datasetVersion":[{"id":null,"value":"Dataset version 1.2","disabled":false}],"description":[{"id":null,"value":"New Description 1.2","disabled":false}]},"attributes":{},"auditFields":{"createdDate":"2025-12-09T13:34:12.193Z","lastUpdatedDate":"2026-02-04T08:03:03.883Z","createdBy":{"id":"af237fbb-a9b9-416b-87e1-8df0670a06df","name":"Abhishek Desai","email":"adesai1@onetrust.com","initials":"AD"},"lastModifiedBy":{"id":"af237fbb-a9b9-416b-87e1-8df0670a06df","name":"Abhishek Desai","email":"adesai1@onetrust.com","initials":"AD"}}}}}}}},"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","AI_GOVERNANCE_READ"]}]},"delete":{"operationId":"deleteUsingEntityTypeIdOrEntityTypeNameUsingDELETE","summary":"Delete Entity","description":"Use this API to delete 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":"Identifier of the entity being removed using the API.","required":true,"schema":{"type":"string","format":"uuid"},"example":"4a32ee83-0127-4d44-ac73-81172d3bd723"}],"responses":{"204":{"description":"No Content - The entity was successfully deleted"},"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"]}]},"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"]}]}},"/api/ai-governance/v1/entity-basic-details/search":{"post":{"operationId":"findEntityBasicDetailsByTypeAndCriteriaUsingPOST","summary":"Get Basic Entity Details","description":"Use this API to retrieve basic 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"]}}],"requestBody":{"content":{"application/json":{"schema":{"description":"Criteria for filtering entities including attribute conditions and sorting preferences","$ref":"#/components/schemas/EntityQueryRequest"},"examples":{"Search DataSets by System type and type":{"summary":"Find all System Type DataSets","description":"Example request to search for DataSets with 'Cassandra' System Type","value":{"criteria":{"fullText":"","filters":[{"field":"type","value":"f930427d-de10-4aee-9013-dd292faa85d8","operator":"EQUAL_TO"},{"field":"source","value":["c77e1ae7-ac3f-47ca-b086-6771f10f299d"],"operator":"EQUAL_TO"}]},"organizationTraversalStrategy":"ANCESTORS_AND_DESCENDANTS"}}}}}},"responses":{"200":{"description":"OK - Successfully retrieved matching entities","content":{"application/json":{"schema":{"description":"Paginated list of basic entity information matching the search criteria","$ref":"#/components/schemas/Page"},"examples":{"Search Results Example":{"summary":"Paginated search results","description":"Example paginated response with basic entity details","value":{"content":[{"displayLabel":"9 | Test Dataset1","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"},{"displayLabel":"10 | Test Dataset2","entityType":{"id":"f9c55c04-0fd4-44dd-b447-b46af9135341","name":"datasets","nameKey":"CE.Datasets.Name","seeded":true,"moduleName":"AIGovernance","schemaName":"datasets"},"id":"0ed3f38b-31ac-45f5-9f85-750214217387","name":"Test Dataset2","number":10,"orgGroupId":"06e43366-1f49-4afd-8c51-3989f9cf98f1","schemaId":"b9c8145e-1431-46f5-922d-2137f0636485"},{"displayLabel":"3 | ds3","entityType":{"id":"f9c55c04-0fd4-44dd-b447-b46af9135341","name":"datasets","nameKey":"CE.Datasets.Name","seeded":true,"moduleName":"AIGovernance","schemaName":"datasets"},"id":"3c2c11e4-1bf1-4d54-ab27-09103ff1bacd","name":"ds3","number":3,"orgGroupId":"06e43366-1f49-4afd-8c51-3989f9cf98f1","schemaId":"b9c8145e-1431-46f5-922d-2137f0636485"},{"displayLabel":"4 | ds44","entityType":{"id":"f9c55c04-0fd4-44dd-b447-b46af9135341","name":"datasets","nameKey":"CE.Datasets.Name","seeded":true,"moduleName":"AIGovernance","schemaName":"datasets"},"id":"7c9c0616-8536-4ed0-94a5-808dcc7f6732","name":"ds44","number":4,"orgGroupId":"06e43366-1f49-4afd-8c51-3989f9cf98f1","schemaId":"b9c8145e-1431-46f5-922d-2137f0636485"},{"displayLabel":"7 | ds5","entityType":{"id":"f9c55c04-0fd4-44dd-b447-b46af9135341","name":"datasets","nameKey":"CE.Datasets.Name","seeded":true,"moduleName":"AIGovernance","schemaName":"datasets"},"id":"12ac9990-0453-4bc0-8259-fccc6632af29","name":"ds5","number":7,"orgGroupId":"06e43366-1f49-4afd-8c51-3989f9cf98f1","schemaId":"b9c8145e-1431-46f5-922d-2137f0636485"},{"displayLabel":"5 | Test DataSet","entityType":{"id":"f9c55c04-0fd4-44dd-b447-b46af9135341","name":"datasets","nameKey":"CE.Datasets.Name","seeded":true,"moduleName":"AIGovernance","schemaName":"datasets"},"id":"c02abfc6-eeb9-40b7-8c92-0d86ca0c1355","name":"Test DataSet","number":5,"orgGroupId":"06e43366-1f49-4afd-8c51-3989f9cf98f1","schemaId":"b9c8145e-1431-46f5-922d-2137f0636485"}],"pageable":{"pageNumber":0,"pageSize":10,"sort":{"empty":false,"sorted":true,"unsorted":false},"offset":0,"paged":true,"unpaged":false},"last":true,"totalElements":6,"totalPages":1,"size":10,"number":0,"sort":{"empty":false,"sorted":true,"unsorted":false},"first":true,"numberOfElements":6,"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"]}]}},"/api/ai-governance/v1/entity-types/search":{"post":{"operationId":"findAllByTypeAndCriteriaUsingPOST_1","summary":"Get List of Entity Types","description":"Use this API to retrieve a list of all entity types 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 Type 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"]}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttributeQueryCriteria"},"examples":{"Search System and Active Entity Types":{"summary":"Example of searching for system and active entity types containing 'dataset' in name","description":"Search System and Active Entity Types","value":{"fullText":"DataSets","filters":[{"field":"moduleScopes.module","value":["AIG"],"operator":"EQUAL_TO"},{"field":"enabled","value":[true],"operator":"EQUAL_TO"},{"field":"seeded","value":[true],"operator":"EQUAL_TO"}]}},"Search Custom and Active Entity Types":{"summary":"Example of searching for custom and active entity types containing 'Dataset' in name","description":"Search Custom and Active Entity Types","value":{"fullText":"GR1","filters":[{"field":"moduleScopes.module","value":["DM"],"operator":"EQUAL_TO"},{"field":"enabled","value":[true],"operator":"EQUAL_TO"},{"field":"seeded","value":[false],"operator":"EQUAL_TO"}]}}}}}},"responses":{"200":{"description":"OK - Returns a paginated list of entity types matching the criteria","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page"},"examples":{"Page of Entity Types":{"summary":"Example of a page containing custom entity types"

# --- truncated at 32 KB (156 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/onetrust/refs/heads/main/openapi/onetrust-ai-governance-openapi.json