{"openapi":"3.1.0","info":{"title":"AI Governance - AI Governance","version":"1.0","contact":{"name":"OneTrust Support","url":"https://my-onetrust-com.ezproxy.jccc.edu/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.ezproxy.jccc.edu/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.ezproxy.jccc.edu/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.ezproxy.jccc.edu/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.ezproxy.jccc.edu/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.ezproxy.jccc.edu/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.ezproxy.jccc.edu/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 migrated 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.ezproxy.jccc.edu/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.ezproxy.jccc.edu/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 migrated 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.ezproxy.jccc.edu/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.ezproxy.jccc.edu/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 migrated 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.ezproxy.jccc.edu/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.ezproxy.jccc.edu/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 migrated 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.ezproxy.jccc.edu/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.ezproxy.jccc.edu/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 migrated 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.ezproxy.jccc.edu/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.ezproxy.jccc.edu/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 migrated 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.ezproxy.jccc.edu/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.ezproxy.jccc.edu/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 migrated 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.ezproxy.jccc.edu/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.ezproxy.jccc.edu/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 migrated 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.ezproxy.jccc.edu/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","description":"Page of Entity Types","value":{"content":[{"auditFields":{"createdDate":"2023-02-20T17:32:03.770Z","lastUpdatedDate":"2023-02-24T14:45:10.230Z"},"description":"","descriptionKey":"f6d7977a-84d3-448d-9440-540fc5710b2f","enabled":true,"id":"c02d15d7-ad0e-4d3b-9037-4580b5bdd7b1","moduleName":"AIGovernance","moduleScopes":["DM","ITRM"],"name":"GR1","nameKey":"36ce5b96-000e-454d-84cd-ffa92f0b35c8","schemaName":"c248b17a-93ea-47e6-bd85-eecd71ce84a7","seeded":false,"settings":{"enableWorkflow":true,"enableWorkflowStageTracking":true,"enableAudit":true,"assessable":true,"enableTask":true,"enableRisk":true,"enableDocument":true,"enableControl":true,"enableWebForm":false,"enableComment":false},"workflowType":"c02d15d7-ad0e-4d3b-9037-4580b5bdd7b1"}],"pageable":{"pageNumber":0,"pageSize":20,"sort":{"empty":false,"sorted":true,"unsorted":false},"offset":0,"paged":true,"unpaged":false},"last":true,"totalPages":1,"totalElements":1,"size":20,"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.ezproxy.jccc.edu/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/{entityTypeId}":{"get":{"operationId":"getEntityTypeInformationUsingGET_1","summary":"Get Entity Type","description":"Use this API to retrieve the details for the specified entity type. The response will return the user who created the entity type, created date, and description.\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 migrated 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.ezproxy.jccc.edu/onetrust/openapi/ai-governance.json"},"parameters":[{"name":"entityTypeId","in":"path","description":"The unique identifier of the entity type.","required":true,"schema":{"description":"Entity type Identifier","type":"string","format":"uuid"},"example":"2aa71ead-0c9a-416a-8471-bdfb67c8d113"}],"responses":{"200":{"description":"OK - Returns the complete details of the requested entity type","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityTypeInformation"},"examples":{"Datasets Entity Type":{"summary":"Example of datasets entity type details","description":"Datasets Entity Type","value":{"id":"061309bc-b319-4af0-bca8-04ffdeba559c","name":"datasets","nameKey":"CE.Datasets.Name","seeded":true,"moduleName":"AIGovernance","schemaName":"datasets","description":"Datasets used for ML / AI applications.","descriptionKey":"CE.Datasets.Description","workflowType":null,"enabled":true,"moduleScopes":["AIG"],"settings":{"enableWorkflow":false,"enableWorkflowStageTracking":false,"enableAudit":true,"assessable":true,"enableTask":true,"enableRisk":true,"enableDocument":true,"enableControl":true,"enableWebForm":false,"enableComment":true},"auditFields":{"createdDate":"2024-02-06T06:13:00.737Z","lastUpdatedDate":"2025-11-26T04:38:53.007Z"}}}}}}},"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.ezproxy.jccc.edu/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/linked-entity-types/entity-types/names/{entityTypeName}/entities/{entityId}/links/pages":{"post":{"operationId":"getRelatedEntitiesForAnEntityUsingPOST","summary":"Get List of Relationship Records by Entity","description":"Use this API to get List of Relationship Records by Entity .\\n> 🗒 Things to Know\\n> \\n> - This API only supports AI Governance Entities (Models, Datasets, AISystems and AIAgents).","tags":["AIGovernance Relationship Management"],"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":10,"maximum":50,"minimum":1}},{"name":"sort","in":"query","description":"Sorting criteria in the format: property,(asc|desc). Example: '?sort=id,desc'","schema":{"type":"string","default":"id,desc","enum":["id,asc","id,desc"]}},{"name":"entityTypeName","in":"path","description":"Name of the Entity Type","required":true,"schema":{"type":"string","enum":["aisystems","datasets","models","aiagents"]},"example":"aisystems"},{"name":"entityId","in":"path","description":"Entity Identifier","required":true,"schema":{"type":"string","format":"uuid"},"example":"4c994bfc-987e-4a24-b0bd-9644e05e9b5d"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttributeQueryCriteria"},"examples":{"Get All Related Entities for a given AISystem":{"summary":"Get All Related Entities for a given AISystem","description":"Get All Related Entities for a given AISystem","value":{"fullText":""}}}}}},"responses":{"200":{"description":"Gets - All Related Entities for a given AISystem.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page"},"examples":{"Related Entities":{"summary":"Related Entities for a given AISystem.","description":"Related Entities","value":{"content":[{"createdDate":"2026-02-19T06:13:22.810Z","id":"8fd085db-f213-4690-8d5a-100449ce880c","lastUpdatedDate":"2026-02-19T06:13:22.810Z","relationshipTypeDetail":{"id":"8857005c-662f-4f90-9e4e-481b225a666a","name":"ai-system-composition","nameKey":"CE.Link.AISystemComposition.Name","schemaName":"ai-system-composition","seeded":true,"moduleName":"CustomEntityManagement","description":"Defines a compositional relationship between AI Systems where one system is an integral part or component of another system","descriptionKey":"CE.Link.AISystemComposition.Description","entityType1ToEntityType2EntityLinkName":"is composed of","entityType1ToEntityType2EntityLinkNameKey":"CE.Link.AISystemComposition.ForwardLabel","entityType2ToEntityType1EntityLinkName":"is a component of","entityType2ToEntityType1EntityLinkNameKey":"CE.Link.AISystemComposition.BackwardLabel","enableAudit":true,"allowNewCustomLinkAssociation":true,"auditFields":{"createdDate":"2025-12-08T15:19:47.897Z","lastUpdatedDate":"2025-12-08T15:19:47.897Z"}},"source":{"linkEntityDetail":{"extendedBaseAttributes":{},"displayLabel":"AISystem 1"},"id":"0f79003f-b177-4f02-aa83-9bf11deec7c7","number":1,"name":"AISystem 1","entityType":{"id":"8a0b318a-d206-4ff9-b1db-00c8c8611d37","name":"aisystems","nameKey":"CE.AISystems.Name","seeded":true,"moduleName":"AIGovernance","schemaName":"aisystems"},"deleted":false},"target":{"linkEntityDetail":{"extendedBaseAttributes":{},"displayLabel":"Model Test"},"id":"296c0a2d-b5f6-450d-8b13-3c2327775042","number":2,"name":"Model Test","entityType":{"id":"963bbab3-8bc9-4787-9ebb-a502775bef54","name":"models","nameKey":"CE.Models.Name","seeded":true,"moduleName":"AIGovernance","schemaName":"models"},"deleted":false}}],"number":0,"size":20,"totalElements":1,"first":true,"last":true,"hasContent":true,"numberOfElements":1,"totalPages":1}}}}}},"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.ezproxy.jccc.edu/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"]}]}},"/api/ai-governance/v1/links":{"post":{"operationId":"createLinkRecordBetweenEntitiesUsingLinkTypeIdUsingPOST","summary":"Create Relationship Record between Entities","description":"Use this API to create a new Relationship Record between entities.\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 migrated 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":["Relationship Management"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.ezproxy.jccc.edu/onetrust/openapi/ai-governance.json"},"parameters":[{"name":"linkTypeId","in":"query","description":"Unique identifier of the link type to use for creating the relationship","required":true,"schema":{"type":"string","format":"uuid"},"example":"2aa71ead-0c9a-416a-8471-bdfb67c8d113"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinkRequest"},"examples":{"Create Model - AISystem Relationship":{"summary":"Example of creating a relationship between a model and AISystem","description":"Create Model - AISystem Relationship","value":{"entity2":{"id":"296c0a2d-b5f6-450d-8b13-3c2327775042","entityType":{"name":"models"}},"entity1":{"id":"0f79003f-b177-4f02-aa83-9bf11deec7c7","entityType":{"name":"aisystems"}},"attributes":null,"context":null}},"Create model-vendor Relationship":{"summary":"Example of creating a is source from relationship between a model and a vendor","description":"Create model-vendor Relationship","value":{"entity1":{"id":"b4c4991c-ab14-4bb2-abae-dad255a513c3","entityType":{"name":"models"}},"entity2":{"id":"690c2d22-d864-4ec7-92ad-850c678a1cd3","entityType":{"name":"vendors"}},"attributes":null,"context":null}}}}}},"responses":{"200":{"description":"Created - The relationship was successfully established","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinkInformation"},"examples":{"Model - AISystem Relationship":{"summary":"Example of created relationship information","description":"Model - AISystem Relationship","value":{"id":"c0f18be7-1205-4417-874c-e5b8d292ac9f","linkType":{"id":"8857005c-662f-4f90-9e4e-481b225a666a","name":"ai-system-composition","nameKey":"CE.Link.AISystemComposition.Name","idOrNamePresent":true},"linkTypeLabel":{"id":5,"entityType1ToEntityType2EntityLinkName":"is composed of","entityType1ToEntityType2EntityLinkNameKey":"CE.Link.AISystemComposition.ForwardLabel","entityType2ToEntityType1EntityLinkName":"is a component of","entityType2ToEntityType1EntityLinkNameKey":"CE.Link.AISystemComposition.BackwardLabel"},"entity1":{"linkEntityDetail":null,"id":"0f79003f-b177-4f02-aa83-9bf11deec7c7","number":null,"name":"AISystem 1","entityType":{"id":"8a0b318a-d206-4ff9-b1db-00c8c8611d37","name":"aisystems","nameKey":"CE.AISystems.Name","seeded":true,"moduleName":"AIGovernance","schemaName":"aisystems"},"deleted":false},"entity2":{"linkEntityDetail":null,"id":"296c0a2d-b5f6-450d-8b13-3c2327775042","number":null,"name":"Model Test","entityType":{"id":"963bbab3-8bc9-4787-9ebb-a502775bef54","name":"models","nameKey":"CE.Models.Name","seeded":true,"moduleName":"AIGovernance","schemaName":"models"},"deleted":false},"schemaId":"f48f80ee-78b6-4dbe-adb4-9872b69b804b","entityLinkDetail":null,"auditFields":{"createdDate":"2026-02-10T13:10:23.267Z","lastUpdatedDate":"2026-02-10T13:10:23.267Z","createdBy":{"id":"d59129eb-7fa7-45b9-a1fb-b29a7f3b13cd","name":null,"email":null,"initials":null},"lastModifiedBy":{"id":"d59129eb-7fa7-45b9-a1fb-b29a7f3b13cd","name":null,"email":null,"initials":null}}}}}}}},"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.ezproxy.jccc.edu/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/links/{linkId}":{"get":{"operationId":"getLinkRecordInformationUsingLinkTypeIdUsingGET","summary":"Get Relationship Record","description":"Use this API to retrieve the details of a specific Relationship Record between entities.\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 migrated 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":["Relationship Management"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.ezproxy.jccc.edu/onetrust/openapi/ai-governance.json"},"parameters":[{"name":"linkTypeId","in":"query","description":"Unique identifier of the link type to use for getting the relationship","required":true,"schema":{"type":"string","format":"uuid"},"example":"2aa71ead-0c9a-416a-8471-bdfb67c8d113"},{"name":"linkId","in":"path","description":"Unique identifier of the link record to retrieve","required":true,"schema":{"description":"Identifier of the link record","type":"string","format":"uuid"},"example":"1bc71ead-0c9a-416a-8471-bdfb67c8d113"}],"responses":{"200":{"description":"OK - Returns the complete details of the requested relationship","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinkInformation"},"examples":{"AISystem - Model Relationship":{"summary":"Example of relationship information","description":"AISystem - Model Relationship","value":{"id":"c0f18be7-1205-4417-874c-e5b8d292ac9f","linkType":{"id":"8857005c-662f-4f90-9e4e-481b225a666a","name":"ai-system-composition","nameKey":"CE.Link.AISystemComposition.Name","idOrNamePresent":true},"linkTypeLabel":{"id":5,"entityType1ToEntityType2EntityLinkName":"is composed of","entityType1ToEntityType2EntityLinkNameKey":"CE.Link.AISystemComposition.ForwardLabel","entityType2ToEntityType1EntityLinkName":"is a component of","entityType2ToEntityType1EntityLinkNameKey":"CE.Link.AISystemComposition.BackwardLabel"},"entity1":{"linkEntityDetail":null,"id":"0f79003f-b177-4f02-aa83-9bf11deec7c7","number":null,"name":"AISystem 1","entityType":{"id":"8a0b318a-d206-4ff9-b1db-00c8c8611d37","name":"aisystems","nameKey":"CE.AISystems.Name","seeded":true,"moduleName":"AIGovernance","schemaName":"aisystems"},"deleted":false},"entity2":{"linkEntityDetail":null,"id":"296c0a2d-b5f6-450d-8b13-3c2327775042","number":null,"name":"Model Test","entityType":{"id":"963bbab3-8bc9-4787-9ebb-a502775bef54","name":"models","nameKey":"CE.Models.Name","seeded":true,"moduleName":"AIGovernance","schemaName":"models"},"deleted":false},"schemaId":"f48f80ee-78b6-4dbe-adb4-9872b69b804b","entityLinkDetail":null,"auditFields":{"createdDate":"2026-02-10T13:10:23.267Z","lastUpdatedDate":"2026-02-10T13:10:23.267Z","createdBy":{"id":"d59129eb-7fa7-45b9-a1fb-b29a7f3b13cd","name":null,"email":null,"initials":null},"lastModifiedBy":{"id":"d59129eb-7fa7-45b9-a1fb-b29a7f3b13cd","name":null,"email":null,"initials":null}}}}}}}},"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.ezproxy.jccc.edu/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"]}]},"delete":{"operationId":"deleteLinkRecordByIdAndTypeUsingLinkTypeIdUsingDELETE","summary":"Remove Relationship Record","description":"Use this API to remove an existing Relationship Record between entities.\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 migrated 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":["Relationship Management"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.ezproxy.jccc.edu/onetrust/openapi/ai-governance.json"},"parameters":[{"name":"linkTypeId","in":"query","description":"Unique identifier of the link type","required":true,"schema":{"type":"string","format":"uuid"},"example":"2aa71ead-0c9a-416a-8471-bdfb67c8d113"},{"name":"linkId","in":"path","description":"Unique identifier of the link record to delete","required":true,"schema":{"description":"Identifier of the link record","type":"string","format":"uuid"},"example":"1bc71ead-0c9a-416a-8471-bdfb67c8d113"}],"responses":{"200":{"description":"OK - The relationship 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.ezproxy.jccc.edu/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"]}]}},"/api/ai-governance/v1/schema-attribute-options":{"post":{"operationId":"addOptionsUsingPOST","summary":"Add Options to Attribute","description":"Use this API to add options to an attribute.\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 migrated 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":["Attribute Management"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.ezproxy.jccc.edu/onetrust/openapi/ai-governance.json"},"parameters":[{"name":"attributeId","in":"query","description":"Unique identifier of the attribute to which options will be added","required":true,"schema":{"type":"string","format":"uuid"},"example":"550e8400-e29b-41d4-a716-446655440000"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"description":"Array of attribute options","type":"array","$ref":"#/components/schemas/AttributeOptionRequest"},"examples":{"Simple Options Example":{"summary":"Add basic options to an attribute","description":"Adds three simple options to a select attribute","value":[{"option":"e","optionKey":"OneTrustApp.OM.CustomEntity.Attributes.a736fc55-7e46-49a5-9e32-c4e3e25d6684"},{"option":"f","optionKey":"OneTrustApp.OM.CustomEntity.Attributes.46fe357c-f1e1-475d-8ee0-45359e6debbb"},{"option":"g","optionKey":"OneTrustApp.OM.CustomEntity.Attributes.06f7fbb3-dddb-40b9-aa5f-00a7271da9e3"}]}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"description":"Attribute details with added options","$ref":"#/components/schemas/AttributeInformation"},"examples":{"Updated Attribute With Options":{"summary":"Response showing attribute with added options","description":"Details of the attribute after new options were added","value":{"id":"123e4567-e89b-12d3-a456-426614174001","name":"Category_select","nameKey":"OneTrustApp.OM.CustomEntity.Attributes.123e4567-e89b-12d3-a456-426614174001","description":"Selection of available categories","descriptionKey":"OneTrustApp.OM.CustomEntity.Attributes.5591a97c-3dbf-4ba9-8770-11ed6c3e9172","encrypted":false,"enabled":true,"required":false,"responseType":"SingleSelect","scoreLevelName":"","options":[{"option":"a","optionKey":"OneTrustApp.OM.CustomEntity.Attributes.79b34d2e-1426-401e-83b2-4fb29c67ac12"},{"option":"b","optionKey":"OneTrustApp.OM.CustomEntity.Attributes.b2a71c8e-7f80-4e87-9e6d-54f2acb93f15"},{"option":"c","optionKey":"OneTrustApp.OM.CustomEntity.Attributes.a1fc2c44-3d8e-4376-af6c-2bdd33a4e0c9"},{"option":"d","optionKey":"OneTrustApp.OM.CustomEntity.Attributes.5ae7d232-0489-4f9d-9645-7a56f3a0a190"},{"option":"e","optionKey":"OneTrustApp.OM.CustomEntity.Attributes.a736fc55-7e46-49a5-9e32-c4e3e25d6684"},{"option":"f","optionKey":"OneTrustApp.OM.CustomEntity.Attributes.46fe357c-f1e1-475d-8ee0-45359e6debbb"},{"option":"g","optionKey":"OneTrustApp.OM.CustomEntity.Attributes.06f7fbb3-dddb-40b9-aa5f-00a7271da9e3"}],"optionType":"none","referenceCategoryIds":[],"responseSubType":null,"maxMultiSelectAllowedOptionValues":null,"metadata":"","formula":null,"createdBy":"admin@example.com","createdTime":"2025-06-18T10:30:15.123Z","lastModifiedBy":"admin@example.com","lastModifiedTime":"2025-06-18T10:59:44.987Z"}}}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttributeInformation"}}}},"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.ezproxy.jccc.edu/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/schema-attributes":{"post":{"operationId":"addAttributeUsingPOST","summary":"Add Attribute to Schema","description":"Use this API to add an attribute to a specific schema.\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 migrated 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":["Attribute Management"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.ezproxy.jccc.edu/onetrust/openapi/ai-governance.json"},"parameters":[{"name":"schemaName","in":"query","description":"Name of the schema where the attribute will be created","required":true,"schema":{"type":"string"},"example":"datasets"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttributeCreateRequest"},"examples":{"Text Attribute Example":{"summary":"Create a simple text attribute","description":"Creates a basic text attribute for the specified schema","value":{"name":"Text Demo Attr","scoreLevelName":"","description":"Text Demo Attr","responseType":"Text","required":false,"encrypted":false,"allowOther":false,"options":[],"optionType":"none","referenceCategoryIds":[],"formula":null,"context":{"parameters":{"RecomputeFormulaEntities":false}},"responseSubType":null,"maxMultiSelectAllowedOptionValues":null,"metadata":""}},"Single Select Attribute Example":{"summary":"Create a single select attribute with options","description":"Creates a single select attribute with predefined options","value":{"name":"Country List Single Select Attribute","scoreLevelName":"","description":"Country List Single Select Attribute","responseType":"SingleSelect","required":false,"encrypted":false,"allowOther":false,"options":[{"option":"India","optionKey":"OneTrustApp.OM.CustomEntity.Attributes.734b69e1-4b53-4f45-a1c2-034a72793d89"},{"option":"Bangladesh","optionKey":"OneTrustApp.OM.CustomEntity.Attributes.622816f4-2d9c-41af-bae5-a49e5640c1d9"},{"option":"China","optionKey":"OneTrustApp.OM.CustomEntity.Attributes.449957d1-112c-403b-87fc-92eb591d4957"},{"option":"USA","optionKey":"OneTrustApp.OM.CustomEntity.Attributes.89175fa8-c181-409d-8a86-9403ea61b81e"}],"optionType":"none","referenceCategoryIds":[],"formula":null,"context":{"parameters":{"RecomputeFormulaEntities":false}},"responseSubType":null,"maxMultiSelectAllowedOptionValues":1,"metadata":""}}}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"description":"Created attribute details","$ref":"#/components/schemas/AttributeInformation"},"examples":{"Text Attribute Response":{"summary":"Response for created text attribute","description":"Details of the created text attribute","value":{"id":"347f4ba0-d705-43c6-a138-16424efb5823","name":"Text Demo Attr","nameKey":"Attributes.l5ahlovqi5cstbwen6m3ca7cua","description":"Text Demo Attr","descriptionKey":"Attributes.dqiw2vt4uvhizhpjlxaolkknni","fieldName":"attributeTextValue.value1_3","mappedFieldName":"attributeTextValue.value1","enabled":true,"required":false,"readOnly":false,"encrypted":false,"allowOther":false,"baseAttribute":false,"responseType":"Text","formula":null,"optionType":"none","optionAllowed":false,"schemaId":"61d99b0d-e980-4339-ac90-2bb21d63da88","schemaName":"datasets","responseMaxLength":1000,"source":null,"responseSubType":null,"multiSelectMaxOptionValues":null,"hidden":false,"abacBasicAssignmentInfo":null,"associatedAttributeFieldName":null}},"Single Select Attribute Response":{"summary":"Response for created single select attribute","description":"Details of the created single select attribute with options","value":{"id":"fc2a023f-b74d-4780-b14a-18f7c6a7cddd","name":"Country List Single Select Attribute","nameKey":"Attributes.t5s5j4gsnjfdpfumdivsyepbri","description":"Country List Single Select Attribute","descriptionKey":"Attributes.lofo7dsaubaavnxxveqpnsnhwq","fieldName":"attributeSingleSelectValue.value1_5","mappedFieldName":null,"enabled":true,"required":false,"readOnly":false,"encrypted":false,"allowOther":false,"baseAttribute":false,"responseType":"SingleSelect","formula":null,"optionType":"none","optionAllowed":true,"schemaId":"61d99b0d-e980-4339-ac90-2bb21d63da88","schemaName":"datasets","options":[{"id":"aadc7dd3-7cf8-4633-80e6-e74326657ae0","option":"Bangladesh","optionKey":"OneTrustApp.OM.CustomEntity.Attributes.622816f4-2d9c-41af-bae5-a49e5640c1d9","enabled":true},{"id":"887ea48e-a278-4424-86ec-e1f6d6e6d131","option":"China","optionKey":"OneTrustApp.OM.CustomEntity.Attributes.449957d1-112c-403b-87fc-92eb591d4957","enabled":true},{"id":"bf58906f-b4bb-4f75-8a49-83eb1dddd4f8","option":"India","optionKey":"OneTrustApp.OM.CustomEntity.Attributes.734b69e1-4b53-4f45-a1c2-034a72793d89","enabled":true},{"id":"0a91f37a-ad9c-408f-ba4e-4f3bb2774f11","option":"USA","optionKey":"OneTrustApp.OM.CustomEntity.Attributes.89175fa8-c181-409d-8a86-9403ea61b81e","enabled":true}],"responseMaxLength":400,"source":null,"responseSubType":null,"multiSelectMaxOptionValues":1,"hidden":false,"abacBasicAssignmentInfo":null,"associatedAttributeFieldName":null}}}}}},"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.ezproxy.jccc.edu/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/schema-attributes/{attributeId}/disable":{"put":{"operationId":"disableAttributeUsingPUT","summary":"Disable Attribute","description":"Use this API to disable an attribute.\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 migrated 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":["Attribute Management"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.ezproxy.jccc.edu/onetrust/openapi/ai-governance.json"},"parameters":[{"name":"schemaId","in":"query","description":"Unique identifier of the schema containing the attribute","required":true,"schema":{"type":"string","format":"uuid"},"example":"550e8400-e29b-41d4-a716-446655440000"},{"name":"attributeId","in":"path","description":"Unique identifier of the attribute to be disabled","required":true,"schema":{"type":"string","format":"uuid"},"example":"550e8400-e29b-41d4-a716-446655440000"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"description":"Disabled attribute details","$ref":"#/components/schemas/AttributeInformation"},"examples":{"Disabled Attribute Response":{"summary":"Response after disabling an attribute","description":"Details of the attribute after it has been disabled","value":{"id":"1ba369d0-ebcd-4340-82ff-aab02f94ae9d","name":"Test 1","nameKey":"OneTrustApp.AIG.Attributes.c19fc626-5e0d-4104-b35b-7a6bea71c8c3","description":"Test 1","descriptionKey":"OneTrustApp.AIG.Attributes.16f33cf1-a6cc-4ed6-859b-4f66021b380e","fieldName":"attributeTextValue.value2_32","mappedFieldName":"attributeTextValue.value2","enabled":false,"required":false,"readOnly":false,"encrypted":false,"allowOther":false,"baseAttribute":false,"responseType":"Text","formula":null,"optionType":"none","optionAllowed":false,"schemaId":"060ef603-4948-4dc6-89da-bd095ab52cfe","schemaName":"aisystems","responseMaxLength":1000,"source":null,"responseSubType":null,"multiSelectMaxOptionValues":null,"hidden":false,"abacBasicAssignmentInfo":null,"associatedAttributeFieldName":null}}}}}},"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.ezproxy.jccc.edu/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/schema-attributes/{attributeId}/enable":{"put":{"operationId":"enableAttributeUsingPUT","summary":"Enable Attribute","description":"Use this API to enable an attribute.\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 migrated 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":["Attribute Management"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.ezproxy.jccc.edu/onetrust/openapi/ai-governance.json"},"parameters":[{"name":"schemaId","in":"query","description":"Unique identifier of the schema containing the attribute","required":true,"schema":{"type":"string","format":"uuid"},"example":"550e8400-e29b-41d4-a716-446655440000"},{"name":"attributeId","in":"path","description":"Unique identifier of the attribute to be enabled","required":true,"schema":{"type":"string","format":"uuid"},"example":"550e8400-e29b-41d4-a716-446655440000"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"description":"Enabled attribute details","$ref":"#/components/schemas/AttributeInformation"},"examples":{"Enabled Attribute Response":{"summary":"Response after enabling an attribute","description":"Details of the attribute after it has been enabled","value":{"id":"1ba369d0-ebcd-4340-82ff-aab02f94ae9d","name":"Test 1","nameKey":"OneTrustApp.AIG.Attributes.c19fc626-5e0d-4104-b35b-7a6bea71c8c3","description":"Test 1","descriptionKey":"OneTrustApp.AIG.Attributes.16f33cf1-a6cc-4ed6-859b-4f66021b380e","fieldName":"attributeTextValue.value2_32","mappedFieldName":"attributeTextValue.value2","enabled":true,"required":false,"readOnly":false,"encrypted":false,"allowOther":false,"baseAttribute":false,"responseType":"Text","formula":null,"optionType":"none","optionAllowed":false,"schemaId":"060ef603-4948-4dc6-89da-bd095ab52cfe","schemaName":"aisystems","responseMaxLength":1000,"source":null,"responseSubType":null,"multiSelectMaxOptionValues":null,"hidden":false,"abacBasicAssignmentInfo":null,"associatedAttributeFieldName":null}}}}}},"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.ezproxy.jccc.edu/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/tasks":{"post":{"operationId":"createTaskUsingPOST_1","summary":"Create Task","description":"Use this API to create a new task for an entity.\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 migrated 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":["Task Management"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.ezproxy.jccc.edu/onetrust/openapi/ai-governance.json"},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskCreateRequest"},"examples":{"Basic Task Creation":{"summary":"Create a simple task with minimal details","description":"Creates a basic task with required fields only","value":{"parentEntityId":"ea2586b9-d40a-41c8-808e-2801e33a757d","taskName":"Review compliance documentation","description":"<p>Review all compliance documentation for the latest model</p>","assigneeId":"e9922cc1-b33b-4a7f-b02a-b0d3645d8e90","deadline":null,"orgGroupId":"06e43366-1f49-4afd-8c51-3989f9cf98f1","taskTypeNameKey":"datasets","priority":"HIGH","collaborators":[]}}}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskInformation"},"examples":{"Task Creation Response":{"summary":"Sample response for a successful task creation","description":"Task Creation Response","value":{"id":"7294afcc-7d18-4231-ac0f-79ed55502947","parentEntityId":"ea2586b9-d40a-41c8-808e-2801e33a757d","taskName":"Albania Test","taskType":{"name":"datasets","nameKey":"TaskRegistry.TaskType.ModuleTask.Name.Datasets","module":"CustomObject","moduleNameTranslationKey":"TaskRegistry.Module.Name.CustomObject","id":"c569969c-94a9-4e2c-869d-e8334063d2ed","label":null,"icon":null},"deadline":null,"status":"Open","priority":"HIGH","description":"<p>Albania Test</p>","orgGroupId":"06e43366-1f49-4afd-8c51-3989f9cf98f1","orgGroupAttribute":{"valueKey":"06e43366-1f49-4afd-8c51-3989f9cf98f1","value":"AIGovernance-New"},"assigneeId":"e9922cc1-b33b-4a7f-b02a-b0d3645d8e90","isActive":true,"sourceType":null,"sourceId":null,"moduleSource":null,"taskAssignmentInformations":[{"userInfo":{"name":"Vinod Ramachandran","nameWithAttributes":"Vinod Ramachandran"},"assigneeId":"e9922cc1-b33b-4a7f-b02a-b0d3645d8e90","type":"USER","isCollaborator":false}],"presentationMode":"DRAWER","isCollaboratorSupported":true,"isCollaboratorGroupSupported":true,"relativeUrl":null,"activity":"COMPLETE_TASK","workflowAndStageBasicInformation":null,"workflowId":null,"workflowStageId":null,"stageName":null,"stageNameKey":null,"badgeColor":null,"dueDateInfo":null,"permissionsMetadata":null,"createdBy":"e9922cc1-b33b-4a7f-b02a-b0d3645d8e90","createdByAttribute":{"valueKey":"e9922cc1-b33b-4a7f-b02a-b0d3645d8e90","value":"Vinod Ramachandran"},"createdDT":"2025-11-20T07:38:02.333Z","modifiedBy":null,"modifiedByAttribute":null,"modifiedDT":null,"completionDate":null,"isRequired":false,"canEditRequiredTask":null,"pastDue":false,"activityKey":"TaskRegistry.ActivityKey.CompleteTask"}}}}}},"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.ezproxy.jccc.edu/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/tasks/{taskId}":{"get":{"operationId":"findTaskUsingGET_1","summary":"Get Task","description":"Use this API to retrieve a specific task on an entity. The response will include details such as the activity history, assignee, and deadline.\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 migrated 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":["Task Management"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.ezproxy.jccc.edu/onetrust/openapi/ai-governance.json"},"parameters":[{"name":"taskId","in":"path","description":"Task Id","required":true,"schema":{"description":"Task identifier","type":"string","format":"uuid"},"example":"d6e48f40-323c-4a3a-a313-b333fac6d61d"},{"name":"includePermissionsMetadata","in":"query","description":"Flag to include permissions metadata","required":false,"schema":{"description":"Flag to include permissions metadata","type":"boolean","default":false},"example":false},{"name":"excludeInactiveTasks","in":"query","description":"Flag to exclude inactive tasks","required":false,"schema":{"description":"Flag to exclude inactive tasks","type":"boolean","default":false},"example":false}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskInformation"},"examples":{"Task Details Response":{"summary":"Sample response with complete task details","description":"Task Details Response","value":{"id":"a1f229b1-8041-48ba-9354-ce90c03ce5b8","parentEntityId":"804c2939-c265-4181-9f52-fbdba80ff042","taskName":"task_01","taskType":{"name":"datasets","nameKey":"TaskRegistry.TaskType.ModuleTask.Name.Datasets","module":"CustomObject","moduleNameTranslationKey":"TaskRegistry.Module.Name.CustomObject","id":"c569969c-94a9-4e2c-869d-e8334063d2ed","label":null,"icon":null},"deadline":"2025-07-01T00:00:00Z","status":"Open","priority":"LOW","description":"<p>desc</p>","orgGroupId":"c9e5a35b-9be7-4dd6-adac-0bee7c02384f","orgGroupAttribute":{"valueKey":"c9e5a35b-9be7-4dd6-adac-0bee7c02384f","value":"PLTF REP"},"assigneeId":"5689bde5-ed2e-47b4-9671-2185cdcd4d31","isActive":true,"sourceType":null,"sourceId":null,"moduleSource":null,"taskAssignmentInformations":[{"userInfo":{"name":"User 1","nameWithAttributes":"User 1"},"assigneeId":"5689bde5-ed2e-47b4-9671-2185cdcd4d31","type":"USER","isCollaborator":false},{"userInfo":{"name":"Vinod Ramachandran","nameWithAttributes":"Arpita K"},"assigneeId":"41955b71-e581-4187-ab6c-d00d1403350c","type":"USER","isCollaborator":true},{"userInfo":{"name":"ADAN-7056_TEST","nameWithAttributes":null},"assigneeId":"4265747b-ca7f-4b71-bfc0-93271214a41a","type":"GROUP","isCollaborator":true}],"presentationMode":"DRAWER","isCollaboratorSupported":true,"isCollaboratorGroupSupported":true,"relativeUrl":"https://lkgb.1trust.app/ai-governance/datasets-type/datasets/804c2939-c265-4181-9f52-fbdba80ff042/details?context=eyJ0ZW5hbnRIYXNoIjoiJDJhJDEwJENSanpTWUJNSE1zeWk3dXE4RG1PZS5pZ3dQUm9XcFllSUFIdE1Wa0JoaGVGVVM2dmFNM0J5In0%3D&contextVersion=1","activity":"COMPLETE_TASK","workflowAndStageBasicInformation":null,"workflowId":null,"workflowStageId":null,"stageName":null,"stageNameKey":null,"badgeColor":null,"dueDateInfo":null,"permissionsMetadata":null,"createdBy":"41955b71-e581-4187-ab6c-d00d1403350c","createdByAttribute":{"valueKey":"41955b71-e581-4187-ab6c-d00d1403350c","value":"Vinod Ramachandran"},"createdDT":"2025-06-12T11:59:08.581Z","modifiedBy":"41955b71-e581-4187-ab6c-d00d1403350c","modifiedByAttribute":{"valueKey":"41955b71-e581-4187-ab6c-d00d1403350c","value":"Vinod Ramachandran"},"modifiedDT":"2025-06-12T12:04:06.048Z","completionDate":null,"isRequired":false,"canEditRequiredTask":null,"pastDue":false,"activityKey":"TaskRegistry.ActivityKey.CompleteTask"}}}}}},"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.ezproxy.jccc.edu/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"]}]},"put":{"operationId":"updateTaskUsingPUT_1","summary":"Update Task","description":"Use this API to update an existing task for an entity.\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 migrated 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":["Task Management"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.ezproxy.jccc.edu/onetrust/openapi/ai-governance.json"},"parameters":[{"name":"taskId","in":"path","description":"UUID of the Task to be updated","required":true,"schema":{"description":"Task identifier","type":"string","format":"uuid"},"example":"4a99acea-0393-4710-a58c-40a68744ecf3"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskUpdateRequest"},"examples":{"Update Task Status":{"summary":"Update task status and progress","description":"Updates a task's status and progress information","value":{"taskName":"task_01","description":"<p>desc</p>","assigneeId":"41955b71-e581-4187-ab6c-d00d1403350c","deadline":"2025-06-30T00:00:00.000","status":"Open","priority":"LOW","collaborators":[{"collaboratorId":"41955b71-e581-4187-ab6c-d00d1403350c","type":"USER"},{"collaboratorId":"4265747b-ca7f-4b71-bfc0-93271214a41a","type":"GROUP"}]}},"Reassign Task":{"summary":"Change task assignee and due date","description":"Reassigns a task to a different person and updates the due date","value":{"taskName":"task_01","description":"<p>desc</p>","assigneeId":"5689bde5-ed2e-47b4-9671-2185cdcd4d31","deadline":"2025-07-01T00:00:00.000","status":"Open","priority":"LOW","collaborators":[{"collaboratorId":"41955b71-e581-4187-ab6c-d00d1403350c","type":"USER"},{"collaboratorId":"4265747b-ca7f-4b71-bfc0-93271214a41a","type":"GROUP"}]}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskInformation"},"examples":{"Updated Task Response":{"summary":"Sample response for a successful task update","description":"Updated Task Response","value":{"id":"a1f229b1-8041-48ba-9354-ce90c03ce5b8","parentEntityId":"804c2939-c265-4181-9f52-fbdba80ff042","taskName":"task_01","taskType":{"name":"datasets","nameKey":"TaskRegistry.TaskType.ModuleTask.Name.Datasets","module":"CustomObject","moduleNameTranslationKey":"TaskRegistry.Module.Name.CustomObject","id":"c569969c-94a9-4e2c-869d-e8334063d2ed","label":null,"icon":null},"deadline":"2025-07-01T00:00:00Z","status":"Open","priority":"LOW","description":"<p>desc</p>","orgGroupId":"c9e5a35b-9be7-4dd6-adac-0bee7c02384f","orgGroupAttribute":{"valueKey":"c9e5a35b-9be7-4dd6-adac-0bee7c02384f","value":"PLTF REP"},"assigneeId":"5689bde5-ed2e-47b4-9671-2185cdcd4d31","isActive":true,"sourceType":null,"sourceId":null,"moduleSource":null,"taskAssignmentInformations":[{"userInfo":{"name":"ADAN-7056_TEST","nameWithAttributes":null},"assigneeId":"4265747b-ca7f-4b71-bfc0-93271214a41a","type":"GROUP","isCollaborator":true},{"userInfo":{"name":"User 1","nameWithAttributes":"User 1"},"assigneeId":"5689bde5-ed2e-47b4-9671-2185cdcd4d31","type":"USER","isCollaborator":false},{"userInfo":{"name":"Arpita K","nameWithAttributes":"Arpita K"},"assigneeId":"41955b71-e581-4187-ab6c-d00d1403350c","type":"USER","isCollaborator":true}],"presentationMode":"DRAWER","isCollaboratorSupported":true,"isCollaboratorGroupSupported":true,"relativeUrl":null,"activity":"COMPLETE_TASK","workflowAndStageBasicInformation":null,"workflowId":null,"workflowStageId":null,"stageName":null,"stageNameKey":null,"badgeColor":null,"dueDateInfo":null,"permissionsMetadata":null,"createdBy":"41955b71-e581-4187-ab6c-d00d1403350c","createdByAttribute":{"valueKey":"41955b71-e581-4187-ab6c-d00d1403350c","value":"Arpita K"},"createdDT":"2025-06-12T11:59:08.581Z","modifiedBy":"41955b71-e581-4187-ab6c-d00d1403350c","modifiedByAttribute":{"valueKey":"41955b71-e581-4187-ab6c-d00d1403350c","value":"Arpita K"},"modifiedDT":"2025-06-12T12:04:05.812Z","completionDate":null,"isRequired":false,"canEditRequiredTask":null,"pastDue":false,"activityKey":"TaskRegistry.ActivityKey.CompleteTask"}}}}}},"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.ezproxy.jccc.edu/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":{"TaskCollaboratorDto":{"type":"object","properties":{"collaboratorId":{"description":"Unique identifier of the collaborator","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"collaboratorEmail":{"description":"Email address of the collaborator","type":"string","example":"collaborator@example.com","maxLength":255,"minLength":5},"type":{"description":"Type of assignee (User or Group)","type":"string","example":"USER","enum":["USER","GROUP"]}},"example":{"collaboratorId":"123e4567-e89b-12d3-a456-426614174000","collaboratorEmail":"collaborator@example.com","type":"USER"},"required":["type"]},"TaskContextInformation":{"type":"object","properties":{"parameters":{"description":"Dynamic key-value parameters for task context","additionalProperties":{"type":"object"},"example":{"taskId":"123e4567-e89b-12d3-a456-426614174000","priority":"HIGH","assignedTo":"john.doe@example.com"},"type":"object"}},"example":{"parameters":{"assignedTo":"john.doe@example.com","priority":"HIGH","taskId":"123e4567-e89b-12d3-a456-426614174000"}}},"TaskUpdateRequest":{"type":"object","properties":{"taskName":{"description":"Name of the task","type":"string","example":"Review document","maxLength":512,"minLength":1},"description":{"description":"Description of the task","type":"string","example":"Please review the attached document and provide feedback","maxLength":2000},"assigneeId":{"description":"ID of the assignee","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"assigneeEmail":{"description":"Email of the assignee","type":"string","example":"user@example.com","maxLength":255,"minLength":5},"collaborators":{"description":"List of task collaborators","type":"array","items":{"$ref":"#/components/schemas/TaskCollaboratorDto"}},"deadline":{"description":"Deadline for the task","type":"string","format":"date-time","example":"2023-12-31T23:59:59"},"status":{"description":"Status of the task","type":"string","example":"Open","enum":["Open","Closed"]},"context":{"description":"Context information for the task","$ref":"#/components/schemas/TaskContextInformation"},"priority":{"description":"Priority level of the task","type":"string","example":"MEDIUM","default":"MEDIUM","enum":["LOW","MEDIUM","HIGH"]},"isRequired":{"description":"Flag indicating if the task is required","type":"boolean","example":false,"default":"false"},"sourceType":{"description":"Type of source that created the task","type":"string","example":"RULES","maxLength":16,"minLength":0},"sourceId":{"description":"ID of the source that created the task","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"}},"example":{"taskName":"Review document","description":"Please review the attached document and provide feedback","assigneeId":"123e4567-e89b-12d3-a456-426614174000","deadline":"2023-12-31T23:59:59","status":"Open","priority":"MEDIUM"},"required":["taskName"]},"AttributeValue":{"type":"object","properties":{"valueKey":{"description":"Key or identifier for the attribute value","type":"string","example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","maxLength":255,"minLength":1},"value":{"description":"The display value of the attribute","type":"string","example":"Document Review Team","maxLength":255,"minLength":1}},"example":{"valueKey":"f47ac10b-58cc-4372-a567-0e02b2c3d479","value":"Document Review Team"},"required":["value","valueKey"]},"DueDateInfo":{"type":"object","properties":{"date":{"description":"The due date timestamp","type":"string","format":"date-time","example":"2023-12-31T23:59:59Z"},"color":{"description":"Color code for displaying the due date","type":"string","example":"#FF0000","maxLength":7,"minLength":1},"icon":{"description":"Icon identifier for the due date status","type":"string","example":"clock-warning","maxLength":50,"minLength":1},"textKey":{"description":"Translation key for text to display with the due date","type":"string","example":"TaskRegistry.DueDate.Overdue","maxLength":255,"minLength":1},"numberOfDays":{"description":"Number of days until or past the due date","type":"integer","format":"int64","example":5}},"example":{"date":"2023-12-31T23:59:59Z","color":"#FF0000","icon":"clock-warning","textKey":"TaskRegistry.DueDate.Overdue","numberOfDays":5},"required":["color","date","icon","numberOfDays","textKey"]},"TaskAssignmentInformation":{"type":"object","properties":{"userInfo":{"description":"Detailed information about the assigned user","$ref":"#/components/schemas/UserInfo"},"assigneeId":{"description":"Unique identifier of the assignee (user or group)","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"type":{"description":"Type of the assignee (user or group)","type":"string","example":"USER","enum":["USER","GROUP"]},"isCollaborator":{"description":"Indicates if this assignment is as a collaborator or primary assignee","type":"boolean","example":false,"default":"false"}},"example":{"taskId":"123e4567-e89b-12d3-a456-426614174000","userInfo":{"id":"123e4567-e89b-12d3-a456-426614174001","name":"John Doe"},"assigneeId":"123e4567-e89b-12d3-a456-426614174000","type":"USER","isCollaborator":false},"required":["assigneeId","isCollaborator","type"]},"TaskInformation":{"type":"object","properties":{"id":{"description":"Unique identifier for the task","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"parentEntityId":{"description":"Identifier of the parent entity","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"taskName":{"description":"Name of the task","type":"string","example":"Review Document XYZ","maxLength":255,"minLength":1},"taskType":{"description":"Information about the task type","example":{"id":"123e4567-e89b-12d3-a456-426614174000","name":"Document Review","description":"Review and approve documents"},"$ref":"#/components/schemas/TaskTypeInformation"},"deadline":{"description":"Deadline for completing the task","type":"string","format":"date-time","example":"2023-12-31T23:59:59Z"},"status":{"description":"Current status of the task","type":"string","example":"Open","enum":["Open","Closed"]},"priority":{"description":"Priority level of the task","type":"string","example":"MEDIUM","enum":["LOW","MEDIUM","HIGH"]},"description":{"description":"Detailed description of the task","type":"string","example":"This task requires reviewing document X and providing feedback","maxLength":4000},"orgGroupId":{"description":"Organization group identifier associated with the task (deprecated)","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000","deprecated":true},"orgGroupAttribute":{"description":"Organization name and identifier information","example":{"value":"OneTrust LLC","valueKey":"123e4567-e89b-12d3-a456-426614174000"},"$ref":"#/components/schemas/AttributeValue"},"assigneeId":{"description":"ID of the task assignee","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"isActive":{"description":"Indicates if the task is active","type":"boolean","example":true,"default":"true"},"sourceType":{"description":"The source type that created the task","type":"string","example":"RULES","maxLength":50},"sourceId":{"description":"ID of the source that created the task","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"moduleSource":{"description":"Source module for the task","type":"string","example":"assessment","enum":["assessment","audit-mgmt","cyber-risk","data-mapping","data-governance","esg","erm","incident","issue","itrm","program-benchmarking","maturity-planning","risk","vendor","vendor-portal","compliance-automation","SpeakUp","EntityScoping","ControlObjective","exception"]},"taskAssignmentInformations":{"description":"List of assignment information for the task","type":"array","items":{"$ref":"#/components/schemas/TaskAssignmentInformation"},"example":[{"assigneeId":"123e4567-e89b-12d3-a456-426614174000","assigneeName":"John Doe","assignmentType":"PRIMARY"}]},"presentationMode":{"description":"The presentation mode for the task","type":"string","example":"DEFAULT","enum":["NAVIGATION","DRAWER"]},"isCollaboratorSupported":{"description":"Indicates if collaborators are supported for this task","type":"boolean","example":true,"default":"false"},"isCollaboratorGroupSupported":{"description":"Indicates if collaborator groups are supported for this task","type":"boolean","example":true,"default":"false"},"relativeUrl":{"description":"Relative URL associated with the task","type":"string","example":"/tasks/review/123","maxLength":255},"activity":{"description":"Activity type for the task","type":"string","example":"COMPLETE_TASK","enum":["COMPLETE_TASK","REVIEW_DSARSUBTASK","APPROVE_RISK","RESPOND_TO_ASSESSMENT","COMPLETE_AUDIT","REVIEW_REQUEST","COURSE_COMPLETION_PENDING","REVIEW_ASSESSMENT","REVIEW_INCIDENT","IMPLEMENT_CONTROL","RISK_TREATMENT","REVIEW_FINDING","ACKNOWLEDGE_TO_ATTESTATION","REVIEW_INITIATIVE","COMPLETE_DISCLOSURE","COMPLETE_DISCLOSURE_ATTESTATION","EVIDENCE_TASK","COMPLETE_DISC_QUESTIONNAIRE","COMPLIANCE_INITIATIVE","REVIEW_ISSUE","CASE_ASSIGNED","SPEAK_UP_QUESTION_ASSIGNED","CONTROL_OBJECTIVE","REVIEW_EXCEPTION"]},"workflowAndStageBasicInformation":{"description":"Basic information about workflow and current stage","type":"object","example":{"workflowName":"Document Approval Workflow","currentStage":"Review Stage","stageOrder":2}},"workflowId":{"description":"ID of the workflow associated with the task","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"workflowStageId":{"description":"ID of the workflow stage associated with the task","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"stageName":{"description":"Name of the current workflow stage","type":"string","example":"Review","maxLength":255},"stageNameKey":{"description":"Translation key for the stage name","type":"string","example":"TaskRegistry.Stage.Review","maxLength":255},"badgeColor":{"description":"Color of the badge for the current stage","type":"string","example":"#4287f5","maxLength":7},"dueDateInfo":{"description":"Information about the due date including formatting details","$ref":"#/components/schemas/DueDateInfo"},"permissionsMetadata":{"description":"Metadata about permissions for this task","type":"object","additionalProperties":{"type":"boolean"}},"createdBy":{"description":"ID of the user who created the task (deprecated)","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000","deprecated":true},"createdByAttribute":{"description":"Information about the user who created the task","example":{"value":"Jane Smith","valueKey":"456e7890-e89b-12d3-a456-426614174000"},"$ref":"#/components/schemas/AttributeValue"},"createdDT":{"description":"Date and time when the task was created","type":"string","format":"date-time","example":"2023-01-15T14:30:00Z"},"modifiedBy":{"description":"ID of the user who last modified the task (deprecated)","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000","deprecated":true},"modifiedByAttribute":{"description":"Information about the user who last modified the task","example":{"value":"Jane Smith","valueKey":"456e7890-e89b-12d3-a456-426614174000"},"$ref":"#/components/schemas/AttributeValue"},"modifiedDT":{"description":"Date and time when the task was last modified","type":"string","format":"date-time","example":"2023-01-20T16:45:00Z"},"completionDate":{"description":"Date and time when the task was completed","type":"string","format":"date-time","example":"2023-01-25T09:15:00Z"},"isRequired":{"description":"Indicates if the task is required","type":"boolean","example":true,"default":"false"},"canEditRequiredTask":{"description":"Indicates if a required task can be edited","type":"boolean","example":false,"default":"false"},"pastDue":{"type":"boolean"},"activityKey":{"type":"string","deprecated":true}},"example":{"id":"123e4567-e89b-12d3-a456-426614174000","taskName":"Document Review Task","status":"Open","priority":"MEDIUM","deadline":"2023-12-31T23:59:59Z","description":"This task requires reviewing document X and providing feedback","assigneeId":"123e4567-e89b-12d3-a456-426614174000","isActive":true,"taskType":{"id":"type-123","name":"Document Review","description":"Review and approve documents"},"moduleSource":"PRIVACY_RIGHTS","activity":"COMPLETE_TASK","presentationMode":"DEFAULT","isCollaboratorSupported":true,"relativeUrl":"/tasks/review/123","workflowId":"workflow-456","stageName":"Review","isPastDue":false,"createdDT":"2023-01-15T14:30:00Z","modifiedDT":"2023-01-20T16:45:00Z","isRequired":true},"required":["deadline","id","isActive","parentEntityId","priority","status","taskName","taskType"]},"TaskTypeInformation":{"type":"object","properties":{"name":{"description":"Name of the task type","type":"string","example":"DOCUMENT_REVIEW","maxLength":100,"minLength":1},"nameKey":{"description":"Translation key for the task type name","type":"string","example":"TaskRegistry.TaskType.DocumentReview","maxLength":255,"minLength":1},"module":{"description":"Module that this task type belongs to","type":"string","example":"ASSESSMENT","maxLength":100,"minLength":1},"moduleNameTranslationKey":{"description":"Translation key for the module name","type":"string","example":"TaskRegistry.Module.Assessment","maxLength":255,"minLength":1},"id":{"description":"Unique identifier for the task type","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"label":{"description":"Display label for the task type","type":"string","example":"Document Review","maxLength":255,"minLength":1},"icon":{"description":"Icon identifier for the task type","type":"string","example":"document-check","maxLength":50,"minLength":1}},"example":{"id":"123e4567-e89b-12d3-a456-426614174000","name":"DOCUMENT_REVIEW","nameKey":"TaskRegistry.TaskType.DocumentReview","module":"ASSESSMENT","moduleNameTranslationKey":"TaskRegistry.Module.Assessment","label":"Document Review","icon":"document-check"},"required":["id","label","module","moduleNameTranslationKey","name","nameKey"]},"UserInfo":{"type":"object","properties":{"name":{"description":"The user's name","type":"string","example":"John Doe","maxLength":255,"minLength":0},"nameWithAttributes":{"description":"The user's name with additional attributes","type":"string","example":"John Doe (Admin, Department: IT)","maxLength":500,"minLength":0}},"example":{"name":"John Doe","nameWithAttributes":"John Doe (Admin, Department: IT)"},"required":["name"]},"AbacBasicAssignmentInfo":{"type":"object","properties":{"assignmentId":{"description":"GUID of the linked assignment","type":"string","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000"},"assignmentName":{"description":"Name of the linked assignment","type":"string","example":"Assignment1"},"policyStatus":{"description":"Policy status of the linked assignment","type":"string","example":"ACTIVE","enum":["INACTIVE","ACTIVE","PROCESSING","FAILED"]}}},"AssociatedAttributeInformation":{"type":"object","properties":{"id":{"description":"Associated Attribute GUID","type":"string","format":"uuid"},"name":{"description":"Name","type":"string","example":"Count of members","minLength":1},"nameKey":{"description":"Name key","type":"string","example":"IM.CountOfMembersName"},"description":{"description":"Description","type":"string","example":"Provide details about count associated with this attribute"},"descriptionKey":{"description":"Description Key","type":"string","example":"IM.CountOfMembersDesc"},"schemaId":{"description":"Attribute Schema GUID","type":"string","format":"uuid"},"schemaName":{"description":"Attribute Schema Name","type":"string","example":"risk"},"fieldName":{"description":"Attribute field name","type":"string","example":"countOfMembers","minLength":1},"mappedFieldName":{"description":"Mapped Attribute field name. Should be used for sorting","type":"string","example":"count"},"enabled":{"description":"Indicator for attribute enabled/disabled","type":"boolean"},"responseType":{"description":"Response Type","type":"string","enum":["Text","SingleSelect","MultiSelect","Date","DateTime","NumericalText","NumericalSingleSelect","RadioButton","TextArea","Formula","Level","Range","Score","System"]},"responseSubType":{"description":"Response sub type","type":"string","enum":["Standard","Formula","Matrix","RollUp"]},"formula":{"description":"Formula for attribute","type":"string","example":"sum(1, 3)"},"options":{"description":"Attribute options","type":"array","items":{"$ref":"#/components/schemas/AttributeOptionInformation"}},"optionsByDomain":{"description":"Override options by Domain","type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/AttributeDomainOptionOverrideInformation"}}}},"required":["enabled","fieldName","id","responseType"]},"AttributeDomainOptionOverrideInformation":{"type":"object","properties":{"id":{"description":"Override Option GUID","type":"string","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000"},"attributeDomainOptionId":{"description":"Domain Option GUID","type":"string","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440001"},"targetAttributeId":{"description":"Target Attribute GUID","type":"string","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440002"},"targetOptionId":{"description":"Target Option GUID","type":"string","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440003"},"option":{"description":"Option name","type":"string","example":"TypeA"},"optionKey":{"description":"Option name key","type":"string","example":"TypeB"},"optionSelectionValue":{"description":"Option selection value","type":"string","example":10},"colorCode":{"description":"Color code for the option","type":"string","example":"#FF5733","maxLength":7},"sequence":{"description":"Option sequence for ordering","type":"integer","format":"int32","example":1,"maximum":32767,"minimum":1},"enabled":{"description":"Indicates if the option is enabled or disabled","type":"boolean","example":true,"default":"true"},"metadata":{"description":"Additional metadata for the attribute option","$ref":"#/components/schemas/AttributeOptionMetadata"},"optionSelectionValueAsDouble":{"type":"number","format":"double"},"optionAsDouble":{"type":"number","format":"double"}}},"AttributeFormulaDetail":{"type":"object","properties":{"formula":{"type":"string"},"formulaType":{"type":"string"}}},"AttributeInformation":{"type":"object","properties":{"id":{"description":"Attribute GUID","type":"string","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000"},"name":{"description":"Attribute name","type":"string","example":"Type of the Record","maxLength":255,"minLength":1},"nameKey":{"description":"Attribute name key which can be used for translation","type":"string","example":"IM.Name","maxLength":255},"description":{"description":"Attribute description","type":"string","example":"Gather Type for the record - provide some value related to nature of record","maxLength":1000},"descriptionKey":{"description":"Attribute description key which can be used for translation","type":"string","example":"IM.Name.Description","maxLength":255},"fieldName":{"description":"Attribute field name which can be used for uniquely identifying an attribute","type":"string","example":"nameOfRecord","maxLength":100,"minLength":1},"mappedFieldName":{"description":"Mapped Attribute field name. Should be used for sorting","type":"string","example":"name","maxLength":100},"enabled":{"description":"Indicator for attribute enabled/disabled","type":"boolean","example":true,"default":"true"},"required":{"description":"Indicator for mandatory attribute","type":"boolean","example":false,"default":"false"},"readOnly":{"description":"Indicator for read only attribute","type":"boolean","example":false,"default":"false"},"encrypted":{"description":"Indicate whether to encrypt the field value or not. Only supported for text, single select and multi select","type":"boolean","example":false,"default":"false"},"allowOther":{"description":"Indicator for allowing user defined options for attribute","type":"boolean","example":false,"default":"false"},"baseAttribute":{"description":"Indicate if attribute is part of extendable entity and which cannot be modified","type":"boolean","example":false,"default":"false"},"responseType":{"description":"Response type for attribute","type":"string","example":"Text","enum":["Text","SingleSelect","MultiSelect","Date","Formula","Score","Level","Range"]},"formula":{"description":"Formula for attribute","type":"string","example":"Default:Field4 + Default:Field3 + 100 + avg(CrossSchema:Field4 + Default:Field3)","maxLength":4000},"optionType":{"description":"Attribute Options value source type","type":"string","example":"None","enum":["None","Static","Dynamic"]},"optionAllowed":{"description":"Indicate if attribute can have static options or not","type":"boolean","example":false,"default":"false"},"schemaId":{"description":"Attribute Schema GUID","type":"string","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000"},"schemaName":{"description":"Attribute Schema Name","type":"string","example":"vendors","maxLength":100},"options":{"description":"Option's for given attribute based on response type","type":"array","items":{"$ref":"#/components/schemas/AttributeOptionInformation"}},"referenceCategories":{"description":"Categories for given attribute","type":"array","items":{"$ref":"#/components/schemas/CategoryInformation"}},"responseMaxLength":{"description":"Response max length","type":"integer","format":"int32","example":4000,"default":"4000","maximum":4000,"minimum":1},"responseSubType":{"description":"Response sub type","type":"string","example":"STANDARD","enum":["STANDARD","FORMULA","MATRIX"]},"associatedAttributeInformation":{"description":"Associated attribute information","type":"array","items":{"$ref":"#/components/schemas/AssociatedAttributeInformation"}},"multiSelectMaxOptionValues":{"description":"MultiSelect max option values","type":"integer","format":"int32","example":10,"maximum":100,"minimum":1},"hidden":{"description":"Hidden","type":"boolean","example":false,"default":"false"},"optionUrl":{"description":"OptionUrl","type":"string","example":"/api/risk-v2/risk-categories","maxLength":255},"intakeQuestion":{"description":"Attribute Intake Question Details","$ref":"#/components/schemas/IntakeQuestion"},"deleteMarker":{"description":"Indicate the status of an attribute's deletion process","type":"string","example":"MARKED_FOR_DELETE","enum":["MARKED_FOR_DELETE","DELETING","DELETED"]},"optionMetadata":{"description":"Option Metadata","$ref":"#/components/schemas/AttributeOptionMetadataInformation"},"validationRuleId":{"description":"Validation Rule configured for Attribute (e.g., email, URL)","type":"string","example":"email"},"abacBasicAssignmentInfo":{"description":"Contains the id, name and ObjectType of the linked assignment","type":"array","items":{"$ref":"#/components/schemas/AbacBasicAssignmentInfo"}},"optionsByDomain":{"description":"Override options by Domain","type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/AttributeDomainOptionOverrideInformation"}}},"formulaByDomain":{"description":"Formula by Domain","type":"object","additionalProperties":{"$ref":"#/components/schemas/AttributeFormulaDetail"}},"displayResponseType":{"description":"Display response type for UI - System attributes are displayed as SingleSelect or MultiSelect based on multiSelectMaxOptionValues","type":"string","example":"SingleSelect","enum":["Text","SingleSelect","MultiSelect","Date","DateTime","NumericalText","NumericalSingleSelect","RadioButton","TextArea","Formula","Level","Range","Score","System"]},"associatedAttributeFieldName":{"type":"string"}},"required":["enabled","fieldName","name"]},"AttributeOptionInformation":{"type":"object","properties":{"id":{"description":"Option GUID","type":"string","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000"},"option":{"description":"Option name","type":"string","example":"TypeA","maxLength":255,"minLength":1},"optionKey":{"description":"Option Key which can be used for translation","type":"string","example":"IM.TypeA","maxLength":255},"colorCode":{"description":"Color code for the option","type":"string","example":"#FF5733","maxLength":7},"sequence":{"description":"Option sequence for ordering","type":"integer","format":"int32","example":1,"maximum":32767,"minimum":1},"enabled":{"description":"Indicates if the option is enabled or disabled","type":"boolean","example":true,"default":"true"},"metadata":{"description":"Additional metadata for the attribute option","$ref":"#/components/schemas/AttributeOptionMetadata"}},"required":["option"]},"AttributeOptionMetadata":{"type":"object","properties":{"hint":{"description":"Hint","type":"string"},"hintKey":{"description":"Hint key which can be used for translation","type":"string"}}},"AttributeOptionMetadataInformation":{"type":"object","properties":{"entityTypeName":{"description":"Option Source Entity Type","type":"string","example":"Location"},"basicServiceContextPath":{"description":"Basic Url for the Option source Service","type":"string","example":"/api/location"},"optionUrl":{"description":"Api URL for the Drop Down Api","type":"string","example":"/api/ontology/ui/v1/entity-types/names/purpose/entities/basic-details/pages"},"optionListUrl":{"description":"Api URL for the Drop Down Api. Complete List of entities","type":"string","example":"/api/ontology/ui/v1/entity-types/names/purpose/entities/basic-details"},"viewType":{"description":"This will help to identify the view type of list","type":"string"},"optionType":{"description":"Option Type","type":"string","example":"BusinessLocations"},"permissions":{"description":"Permissions","type":"array","items":{"type":"string"},"example":"[features.core-constructs.view]"},"applicationUrl":{"description":"Application Url","type":"string","example":"/settings/location-management/location/Location"}}},"CategoryInformation":{"type":"object","properties":{"id":{"description":"Category unique identifier","type":"string","format":"uuid"},"name":{"description":"Category name","type":"string","example":"Financial Category"},"nameKey":{"description":"Category nameKey for localization support","type":"string","example":"IM.FinancialCategoryName"}}},"IntakeQuestion":{"type":"object","properties":{"nameKey":{"type":"string","maxLength":100,"minLength":0},"name":{"type":"string","maxLength":500,"minLength":0},"descriptionKey":{"type":"string","maxLength":100,"minLength":0},"description":{"type":"string","maxLength":500,"minLength":0}}},"TaskCreateRequest":{"type":"object","properties":{"parentEntityId":{"description":"ID of the parent entity","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"taskName":{"description":"Name of the task","type":"string","example":"Review document","maxLength":512,"minLength":0},"description":{"description":"Description of the task","type":"string","example":"Please review the attached document and provide feedback","maxLength":2000},"orgGroupId":{"description":"Organization group ID","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"taskTypeNameKey":{"description":"Key identifying the task type","type":"string","example":"REVIEW_TASK","maxLength":100,"minLength":1},"assigneeId":{"description":"ID of the assignee","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"assigneeEmail":{"description":"Email of the assignee","type":"string","example":"user@example.com","maxLength":255,"minLength":5},"collaborators":{"description":"List of task collaborators","type":"array","items":{"$ref":"#/components/schemas/TaskCollaboratorDto"}},"deadline":{"description":"Deadline for the task","type":"string","format":"date-time","example":"2023-12-31T23:59:59"},"context":{"description":"Context information for the task","$ref":"#/components/schemas/TaskContextInformation"},"isActive":{"description":"Flag indicating if the task is active","type":"boolean","example":true,"default":"false"},"sourceType":{"description":"Type of source that created the task","type":"string","example":"RULES","maxLength":16,"minLength":0},"sourceId":{"description":"ID of the source that created the task","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"resourceId":{"description":"ID of the resource","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"resourceTypeNameKey":{"description":"Key identifying the resource type","type":"string","example":"ASSESSMENT","maxLength":100,"minLength":1},"moduleSource":{"description":"Source module","type":"string","enum":["assessment","audit-mgmt","cyber-risk","data-mapping","data-governance","esg","erm","incident","issue","itrm","program-benchmarking","maturity-planning","risk","vendor","vendor-portal","compliance-automation","SpeakUp","EntityScoping","ControlObjective","exception"]},"priority":{"description":"Priority level of the task","type":"string","example":"MEDIUM","default":"MEDIUM","enum":["LOW","MEDIUM","HIGH"]},"isRequired":{"description":"Flag indicating if the task is required","type":"boolean","example":false,"default":"false"}},"example":{"parentEntityId":"123e4567-e89b-12d3-a456-426614174000","taskName":"Review document","description":"Please review the attached document and provide feedback","orgGroupId":"123e4567-e89b-12d3-a456-426614174000","taskTypeNameKey":"REVIEW_TASK","assigneeId":"123e4567-e89b-12d3-a456-426614174000","deadline":"2023-12-31T23:59:59","priority":"MEDIUM"},"required":["orgGroupId","parentEntityId","taskName","taskTypeNameKey"]},"AssociatedAttribute":{"type":"object","properties":{"fieldName":{"description":"Field Name","type":"string","maxLength":200,"minLength":0},"name":{"description":"Attribute Name","type":"string","minLength":1},"nameKey":{"description":"Attribute Name Key. Used for Translation","type":"string","maxLength":200,"minLength":0},"description":{"description":"Attribute Description","type":"string"},"descriptionKey":{"description":"Attribute Description Key","type":"string","maxLength":200,"minLength":0},"options":{"description":"Attribute Options","type":"array","items":{"$ref":"#/components/schemas/AttributeOptionRequest"},"minItems":1}},"required":["name"]},"AssociatedAttributeRequest":{"type":"object","properties":{"associatedAttributes":{"description":"Associated attributes","type":"array","items":{"$ref":"#/components/schemas/AssociatedAttribute"},"minItems":1}}},"AttributeContext":{"type":"object","properties":{"parameters":{"additionalProperties":{"type":"object"},"type":"object"}}},"AttributeCreateRequest":{"type":"object","properties":{"fieldName":{"description":"Field name used to uniquely identify the attribute","type":"string","example":"nameOfRecord","maxLength":200,"minLength":0},"name":{"description":"Attribute name","type":"string","example":"Type of the Record","maxLength":255,"minLength":1},"nameKey":{"description":"Attribute name key used for translation","type":"string","example":"IM.Name","maxLength":200,"minLength":0},"description":{"description":"Attribute description","type":"string","example":"Gather Type for the record - provide some value related to nature of record","maxLength":1000},"descriptionKey":{"description":"Attribute description key used for translation","type":"string","example":"IM.Name.Description","maxLength":200,"minLength":0},"required":{"description":"Indicates if this attribute is required","type":"boolean","example":false,"default":"false"},"allowOther":{"description":"Indicates if user-specified values are allowed","type":"boolean","example":false,"default":"false"},"responseType":{"description":"Response type for the attribute","type":"string","example":"Text","enum":["Text","SingleSelect","MultiSelect","Date","Formula","Score","Level","Range"]},"optionType":{"description":"Source for attribute options","type":"string","example":"None","default":"None","enum":["None","Static","Dynamic"],"maxLength":200,"minLength":0},"options":{"description":"List of options for the attribute (applicable for SingleSelect and MultiSelect)","type":"array","items":{"$ref":"#/components/schemas/AttributeOptionRequest"}},"referenceCategoryIds":{"description":"List of category IDs associated with the attribute","type":"array","items":{"type":"string","format":"uuid"},"example":["550e8400-e29b-41d4-a716-446655440000"]},"formula":{"description":"Formula expression for calculated attributes","type":"string","example":"Default:Field4 + Default:Field3 + 100","maxLength":8000,"minLength":0},"context":{"description":"Attribute context data","$ref":"#/components/schemas/AttributeContext"},"source":{"description":"Source of the attribute","type":"string","example":"system","maxLength":50},"responseSubType":{"description":"Response sub type for the attribute","type":"string","example":"STANDARD","enum":["STANDARD","FORMULA","MATRIX"]},"associatedAttributeRequest":{"description":"Associated attribute request information","$ref":"#/components/schemas/AssociatedAttributeRequest"},"maxMultiSelectAllowedOptionValues":{"description":"Maximum number of option values allowed for MultiSelect attributes","type":"integer","format":"int32","example":10,"maximum":100,"minimum":1},"encrypted":{"description":"Indicates if this attribute should be encrypted","type":"boolean","example":false,"default":"false"},"metadata":{"description":"Metadata about the attribute in JSON format","type":"string","example":{"sortable":true,"filterOperators":["EQUAL_TO","NOT_EQUAL_TO"]}},"intakeQuestion":{"description":"Attribute intake question details","$ref":"#/components/schemas/IntakeQuestion"},"validationRuleId":{"description":"ID of the validation rule to associate with the attribute","type":"string","example":"email","maxLength":255},"abacBasicAssignmentInfo":{"description":"GUID, name and the objectType of the linked assignment","type":"array","items":{"$ref":"#/components/schemas/AbacBasicAssignmentInfo"}}},"required":["fieldName","name","responseType"]},"AttributeOptionRequest":{"type":"object","properties":{"option":{"description":"The option text to be displayed","type":"string","example":"Example Option","maxLength":255,"minLength":1},"optionKey":{"description":"Option key which can be used for translation and internationalization","type":"string","example":"example_option","maxLength":255},"optionSelectionValue":{"description":"Option selection value used to identify the option in forms or programmatic interfaces","type":"string","example":"value1","maxLength":255},"colorCode":{"description":"Color code in hexadecimal format for UI representation","type":"string","example":"#FFFFFF","enum":["#000000","#FFFFFF","#FF0000","#00FF00","#0000FF"],"maxLength":7,"minLength":4,"pattern":"^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$"},"metadata":{"description":"Additional metadata associated with the attribute option","example":{"hint":"This option provides additional information about the attribute","hintKey":"attribute.option.hint.key"},"$ref":"#/components/schemas/AttributeOptionMetadata"}},"example":{"option":"Example Option","optionKey":"example_option","optionSelectionValue":"value1","colorCode":"#FFFFFF"},"required":["option"],"title":"Attribute Option Request"},"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"]},"EntityDetailRequest":{"type":"object","properties":{"extendedBaseAttributes":{"description":"Base Seeded Attributes","type":"object","example":{"textAttributeName":[{"value":"Text"}],"optionBasedAttributeName":[{"id":"f2229953-b4b5-4042-8cb9-b78038cc4c46"}]},"additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/AttributeValueInformation"}}}}},"LinkRequest":{"type":"object","properties":{"attributes":{"description":"Custom Attributes based on schema defined for given link type","type":"object","example":{"textAttributeName":[{"value":"Text"}],"optionBasedAttributeName":[{"id":"f2229953-b4b5-4042-8cb9-b78038cc4c46"}]},"additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/AttributeValueInformation"}}},"entity1":{"description":"Associated Entity Instance for given Entity Type","example":{"id":"f2229953-b4b5-4042-8cb9-b78038cc4c46","entityType":{"id":"d1119953-b4b5-4042-8cb9-b78038cc4c46","name":"Vendor"}},"$ref":"#/components/schemas/LinkedEntityInformation"},"entity2":{"description":"Associated Entity Instance for given Entity Type","example":{"id":"a2129953-b4b5-4042-8cb9-b78038cc4c46","entityType":{"id":"d1119953-b4b5-4042-8cb9-b78038cc4c46","name":"Vendor"}},"$ref":"#/components/schemas/LinkedEntityInformation"}},"required":["entity1","entity2"]},"LinkedEntityInformation":{"type":"object","properties":{"linkEntityDetail":{"description":"Link entity details extended base properties","example":{"includeCustomFields":true,"includeStandardFields":true},"$ref":"#/components/schemas/EntityDetailRequest"},"id":{"description":"Unique identifier of the entity","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"number":{"description":"Auto-generated sequential entity number","type":"integer","format":"int64","example":1024,"maximum":9999999,"minimum":1,"readOnly":true},"name":{"description":"Name of the entity","type":"string","example":"OneTrust DataGuidance","maxLength":255,"minLength":1},"detailsAccessRestricted":{"description":"Flag indicating whether entity is view-only","type":"boolean","example":false},"redirectURL":{"description":"Redirect URL for the entity","type":"string","example":"/entity/product/f2229953-b4b5-4042-8cb9-b78038cc4c46"},"entityType":{"description":"Basic information about the entity type","example":{"id":"d1119953-b4b5-4042-8cb9-b78038cc4c46","name":"Product","displayName":"Product","nameKey":"entity.type.product","displayNameKey":"entity.type.product.display","module":"VENDOR"},"$ref":"#/components/schemas/BasicEntityTypeInformation"},"deleted":{"type":"boolean"}},"example":{"id":"f2229953-b4b5-4042-8cb9-b78038cc4c46","number":1024,"name":"OneTrust DataGuidance","isDeleted":false,"detailsAccessRestricted":false,"redirectURL":"/entity/product/f2229953-b4b5-4042-8cb9-b78038cc4c46","entityType":{"id":"d1119953-b4b5-4042-8cb9-b78038cc4c46","name":"Product","displayName":"Product","nameKey":"entity.type.product","displayNameKey":"entity.type.product.display","module":"VENDOR"},"linkEntityDetail":{"includeCustomFields":true,"includeStandardFields":true}},"required":["entityType","id","number"],"title":"Linked Entity Information"},"BasicLinkTypeLabelInformation":{"type":"object","properties":{"id":{"description":"Pk of an Link Type Object Type Pair","type":"integer","format":"int64","example":1},"entityType1ToEntityType2EntityLinkName":{"description":"Link type name from EntityType1-EntityType2","type":"string","example":"OneTrust provides GRC"},"entityType2ToEntityType1EntityLinkName":{"description":"Link type name from EntityType2-EntityType1","type":"string","example":"GRC belongs to OneTrust"}},"required":["id"]},"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"]},"IdOrNameLinkType":{"type":"object","properties":{"id":{"description":"Unique Identifier of an Link Type","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"name":{"description":"Name of an Link Type","type":"string","example":"Product/Service"},"idOrNamePresent":{"type":"boolean"}}},"LinkInformation":{"type":"object","properties":{"id":{"description":"Unique identifier of the link record. Auto-generated when a new link is created.","type":"string","format":"uuid","example":"d1119953-b4b5-4042-8cb9-b78038cc4c46","readOnly":true},"linkType":{"description":"Link type information defining the type of relationship. Can be specified by ID or name.","example":{"name":"Related"},"$ref":"#/components/schemas/IdOrNameLinkType"},"linkTypeLabel":{"description":"Link type label information showing the directional relationship names between the two entities.","example":{"entityType1ToEntityType2EntityLinkName":"Send Data To","entityType2ToEntityType1EntityLinkName":"Receive Data From"},"$ref":"#/components/schemas/BasicLinkTypeLabelInformation"},"entity1":{"description":"Source entity information for this relationship. Contains entity identifier and type details.","example":{"id":"f2229953-b4b5-4042-8cb9-b78038cc4c46","entityType":{"id":"d1119953-b4b5-4042-8cb9-b78038cc4c46","name":"Vendor"}},"$ref":"#/components/schemas/LinkedEntityInformation"},"entity2":{"description":"Target entity information for this relationship. Contains entity identifier and type details.","example":{"id":"a2129953-b4b5-4042-8cb9-b78038cc4c46","entityType":{"id":"d1119953-b4b5-4042-8cb9-b78038cc4c46","name":"Vendor"}},"$ref":"#/components/schemas/LinkedEntityInformation"},"schemaId":{"description":"Unique identifier of the schema used for this link type.","type":"string","format":"uuid","example":"d1119953-b4b5-4042-8cb9-b78038cc4c46","readOnly":true},"auditFields":{"description":"Audit information for the link including creation and modification details. Contains information about when the link was created/modified and by whom.","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":"d1119953-b4b5-4042-8cb9-b78038cc4c46","linkType":{"name":"Related"}},"required":["entity1","entity2","id","linkType"],"title":"Link Information"},"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"}},"BasicAttributeInformation":{"type":"object","properties":{"id":{"description":"Unique Identifier of an Entity Attribute","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"value":{"description":"Value of an Entity Attribute","type":"string","example":"Galaxy"}}},"BasicLinkCreateSourceRequest":{"type":"object","properties":{"attributes":{"description":"Custom attributes for the link based on the link type schema. Contains attribute paths mapped to their values.","type":"object","example":{"textAttributeName":[{"value":"Text"}],"optionBasedAttributeName":[{"id":"f2229953-b4b5-4042-8cb9-b78038cc4c46"}]},"additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/AttributeValueInformation"}}},"entity1":{"description":"The first entity in the relationship (source entity). Contains entity identifier and type details.","example":{"id":"f2229953-b4b5-4042-8cb9-b78038cc4c46","entityType":{"id":"d1119953-b4b5-4042-8cb9-b78038cc4c46","name":"Vendor"}},"$ref":"#/components/schemas/LinkedEntityInformation"},"entity2":{"description":"The second entity in the relationship (target entity). Contains entity identifier and type details.","example":{"id":"a2129953-b4b5-4042-8cb9-b78038cc4c46","entityType":{"id":"d1119953-b4b5-4042-8cb9-b78038cc4c46","name":"Vendor"}},"$ref":"#/components/schemas/LinkedEntityInformation"},"entityLinkTypeId":{"description":"Unique identifier of the link type that defines the relationship. Required if sourceSystemGenerator is not provided.","type":"string","format":"uuid","example":"d1119953-b4b5-4042-8cb9-b78038cc4c46"},"sourceSystemGenerator":{"description":"Identifier of the system that generates this link. Required if entityLinkTypeId is not provided.","type":"string","example":"LINK-SOURCE"},"linkTypeLabel":{"description":"Display name for the relationship direction. Used for showing the relationship in UI.","type":"string","example":"Sends Data To"}},"example":{"entity1":{"id":"f2229953-b4b5-4042-8cb9-b78038cc4c46","entityType":{"name":"Vendor"}},"entity2":{"id":"a2129953-b4b5-4042-8cb9-b78038cc4c46","entityType":{"name":"Asset"}},"entityLinkTypeId":"d1119953-b4b5-4042-8cb9-b78038cc4c46"},"required":["entity2"],"title":"Basic Link Create Source Request"},"EntityCreateRequest":{"type":"object","properties":{"name":{"description":"The name of the entity. Required field used as the primary identifier for users.","type":"string","example":"OneTrust","maxLength":255,"minLength":1},"organization":{"description":"The organization group that owns this entity. Contains organization ID and optional name.","example":{"id":"f2229953-b4b5-4042-8cb9-b78038cc4c46","name":"Organization Name"},"$ref":"#/components/schemas/EntityOrganizationInformation"},"attributes":{"description":"The custom attributes for the entity defined by its schema. Contains attribute paths mapped to their values.","type":"object","example":{"textAttributeName":[{"value":"Text"}],"optionBasedAttributeName":[{"id":"f2229953-b4b5-4042-8cb9-b78038cc4c46"}]},"additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/AttributeValueInformation"}}},"workflowAndStage":{"description":"Requested workflow and stage to be assigned to the entity during creation. Contains workflow and stage identifiers.","example":{"workflow":{"id":"f2229953-b4b5-4042-8cb9-b78038cc4c46","value":"Workflow Name"},"stage":{"id":"d2329953-b4b5-4042-8cb9-b78038cc4c46","value":"Stage Name"}},"$ref":"#/components/schemas/EntityWorkflowStageRequest"},"entityLinks":{"description":"Entity link requests to create relationships with other entities during entity creation","type":"array","items":{"$ref":"#/components/schemas/BasicLinkCreateSourceRequest"},"example":[{"entity1":{"id":"ad49a0f1-3d3d-4352-9daf-71f6ea2b2c86","entityType":{"name":"Issue"}},"entityLinkTypeId":"a1fe9bea-1e27-4f33-bd1c-3420b894bbb0"}]}},"example":{"name":"OneTrust","organization":{"id":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"attributes":{"textAttributeName":[{"value":"Text"}]}},"required":["name"],"title":"Entity Create Request"},"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"]},"EntityWorkflowStageRequest":{"type":"object","properties":{"workflow":{"description":"Workflow to be assigned to the entity. The entity type must have this workflow type defined in its settings.","example":{"id":"f2229953-b4b5-4042-8cb9-b78038cc4c46","value":"Example Workflow"},"$ref":"#/components/schemas/BasicAttributeInformation"},"stage":{"description":"Workflow stage to be assigned to the entity within the specified workflow. Must be a valid stage for the given workflow.","example":{"id":"c86539953-b4b5-4042-8cb9-b78038ccfc46","value":"Example Stage"},"$ref":"#/components/schemas/BasicAttributeInformation"},"closedDate":{"description":"Date when the entity was closed. Only relevant for workflows with closed stages.","type":"string","format":"date-time","example":"2017-02-03T10:37:30Z"}},"example":{"workflow":{"id":"f2229953-b4b5-4042-8cb9-b78038cc4c46","value":"Example Workflow"},"stage":{"id":"c86539953-b4b5-4042-8cb9-b78038ccfc46","value":"Example Stage"}},"title":"Entity Workflow Stage Request"},"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"]},"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"]}}},"WorkflowSpecificStageNavigationRequest":{"type":"object","properties":{"nextStageName":{"description":"Name of the next stage to navigate to","type":"string","example":"Investigation"},"parameters":{"description":"Additional parameters for workflow navigation customization","additionalProperties":{"type":"object"},"example":{"skipValidation":true,"notifyUsers":false},"type":"object"}},"example":{"nextStageName":"Investigation","parameters":{"notifyUsers":false,"priority":"high","reason":"Critical security incident","skipValidation":true}},"required":["nextStageName"]},"AdvanceStageActionInformation":{"type":"object","properties":{"id":{"description":"Advance Stage Action Identifier","type":"string","format":"uuid"},"actionType":{"description":"Advance Stage Action Type","type":"string","enum":["ATTRIBUTES, ATTACHMENT"]},"actionMetadata":{"description":"Advance Stage Action metadata","type":"object","additionalProperties":{"type":"object"}}},"required":["actionType","id"]},"StageExceptionInformation":{"type":"object","properties":{"stageExceptionApprovers":{"description":"Workflow Stage Exception Approvers","type":"array","items":{"$ref":"#/components/schemas/WorkflowStageApproverInformation"}},"exceptionGrantedTargetStageId":{"description":"Target stage for exception approval","type":"string","format":"uuid"},"workflowExceptionApprovalRequiredFromAll":{"description":"Is exception required from all approvers","type":"boolean"}}},"WorkflowStageApproverInformation":{"type":"object","properties":{"id":{"description":"Workflow Stage Approver Identifier","type":"string","format":"uuid"},"workFlowStageId":{"description":"Workflow Stage Id","type":"string","format":"uuid"},"approverType":{"description":"Workflow Stage Approver Type","type":"string","enum":["SYSTEM_USER, USER_ATTRIBUTE"]},"approverUserId":{"description":"Workflow Stage Approver User Id, User ID from Onetrust System","type":"string","format":"uuid"},"referenceApproverUserSourceId":{"description":"Reference identifier for approver' source. ie, fieldName from attribute Manager","type":"string"},"referenceApproverUserSourceOwner":{"description":"Reference Source Owner. ie, schemaname from attribute manager","type":"string"},"approverUserGroupId":{"description":"Workflow Stage Approver User Group Id, User Group ID from Onetrust System","type":"string","format":"uuid"},"approverCategory":{"description":"Field to indicate if the approver is for stage approval or exception","type":"string"},"customFields":{"description":"Custom fields","type":"object","additionalProperties":{"type":"object"}}},"required":["approverType","id","workFlowStageId"]},"WorkflowStageListInformation":{"type":"object","properties":{"id":{"description":"Workflow Stage Identifier","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"name":{"description":"Workflow Stage Name","type":"string","example":"Investigation"},"nameKey":{"description":"Workflow Stage Name Key for translation purposes","type":"string","example":"workflow.stage.investigation"},"description":{"description":"Workflow Stage Description","type":"string","example":"Investigation stage for incident workflow"},"descriptionKey":{"description":"Workflow Stage Description Key for translation purposes","type":"string","example":"workflow.stage.investigation.description"},"sequence":{"description":"Workflow Stage Sequence number","type":"integer","format":"int32","example":2,"minimum":1},"allowDeletion":{"description":"Indicates if Workflow Stage can be deleted","type":"boolean","example":true,"default":"false"},"badgeColor":{"description":"Workflow Stage Badge Color for UI purposes","type":"string","example":"blue"},"approvalStage":{"description":"Indicates if the stage is an approval stage","type":"boolean","example":true,"default":"false"},"exceptionStage":{"description":"Indicates if the stage is an exception approval stage","type":"boolean","example":false,"default":"false"},"autoAdvanceOnApproval":{"description":"Can Workflow Stage Auto-Advance on Approval?","type":"boolean","example":true,"default":"false"},"customFields":{"description":"Custom fields","type":"object","example":{"priority":"high","category":"security"},"additionalProperties":{"type":"object"}},"stageApprovers":{"description":"Workflow Stage Approvers","type":"array","items":{"$ref":"#/components/schemas/WorkflowStageApproverInformation"}},"additionalFields":{"description":"Additional fields associated with Workflow Stage","type":"object","example":{"notificationEnabled":true},"additionalProperties":{"type":"object"}},"advanceStageActionEnabled":{"description":"Does Workflow Stage has advance stage action enabled?","type":"boolean","example":true,"default":"false"},"advanceStageActions":{"description":"Workflow Stage Advance Actions","type":"array","items":{"$ref":"#/components/schemas/AdvanceStageActionInformation"}},"stageExceptionConfiguration":{"description":"Workflow Stage Exception details","$ref":"#/components/schemas/StageExceptionInformation"}},"example":{"id":"123e4567-e89b-12d3-a456-426614174000","name":"Investigation","nameKey":"workflow.stage.investigation","description":"Investigation stage for incident workflow","descriptionKey":"workflow.stage.investigation.description","sequence":2,"allowDeletion":true,"badgeColor":"blue","approvalStage":true,"exceptionStage":false,"autoAdvanceOnApproval":true,"customFields":{"priority":"high","category":"security"},"stageApprovers":[{"id":"abc-123","name":"Security Approver"}],"additionalFields":{"notificationEnabled":true},"advanceStageActionEnabled":true,"advanceStageActions":[{"id":"def-456","name":"Approve"}],"stageExceptionConfiguration":{"enabled":true,"approverCount":2}},"required":["id","name","sequence"]},"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"},"EntityTypeInformation":{"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"]},"description":{"description":"Description of the entity type","type":"string","example":"A third-party organization that provides goods or services to the company"},"descriptionKey":{"description":"Translation key for the description","type":"string","example":"entity.type.vendor.description"},"workflowType":{"description":"Workflow type associated with the entity type","type":"string","example":"vendor_assessment"},"enabled":{"description":"Flag indicating whether the entity type is enabled","type":"boolean","example":true,"default":"true"},"moduleScopes":{"description":"Module scopes for the entity type","type":"array","items":{"type":"string"},"example":["AIG","AA","DM","ESG"],"enum":["AIG","AA","DM","ESG","ITRM"]},"settings":{"description":"Entity type settings","example":{"enableSearch":true,"enableQuickCreate":true,"enableExtendedAttributes":true,"enableDuplicateDetection":true,"workflowEnabled":true,"auditEnabled":true},"$ref":"#/components/schemas/EntityTypeSettingInformation"},"auditFields":{"description":"Audit fields containing information about creation and modification","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"}},"example":{"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"}},"required":["id","name","settings"]},"EntityTypeSettingInformation":{"type":"object","properties":{"enableWorkflow":{"description":"Indicate workflow is enabled for given entity type","type":"boolean","example":true},"enableWorkflowStageTracking":{"description":"Indicate current setting to record entity workflow stage tracking history","type":"boolean","example":true},"assessable":{"description":"Indicate if entity type are assessable or not","type":"boolean","example":false},"enableTask":{"description":"Indicate tasks are enabled for given entity type","type":"boolean","example":false},"enableRisk":{"description":"Indicate risks are enabled for given entity type","type":"boolean","example":false},"enableDocument":{"description":"Indicate documents are enabled for given entity type","type":"boolean","example":false},"enableControl":{"description":"Indicate controls are enabled for given entity type","type":"boolean","example":false},"enableWebForm":{"description":"Indicate web forms are enabled for given entity type","type":"boolean","example":false},"enableComment":{"description":"Indicate comments are enabled for given entity type","type":"boolean","example":false}},"required":["assessable","enableComment","enableControl","enableDocument","enableRisk","enableTask","enableWebForm","enableWorkflow","enableWorkflowStageTracking"]}},"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"}}}}}}}