OneTrust Platform — Inventory

{"openapi":"3.1.0","info":{"title":"Platform - Inventory","version":"1.0","contact":{"name":"OneTrust Support","url":"https://my.onetrust.com/s/contactsupport"},"license":{"name":"Apache 2.0","url":"https://www.apache.org/licenses/LICENSE-2.0"},"description":"The Inventory APIs are used to manage relationships and link data within the inventory."},"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":"Inventory Relationships V2","description":"The Inventory Relationships V2 APIs are used to manage V2 inventory relationships.","externalDocs":{"description":"OpenAPI 3.1.0 - Download Definition","url":"https://developer.onetrust.com/onetrust/openapi/platform-inventory.json"}},{"name":"Relationship Management","description":"The Relationship Management APIs are used to manage relationships between entities.","externalDocs":{"description":"OpenAPI 3.1.0 - Download Definition","url":"https://developer.onetrust.com/onetrust/openapi/platform-inventory.json"}}],"x-onetrust":{"spec-label":"OpenAPI 3.1.0"},"x-readme":{"explorer-enabled":false,"proxy-enabled":false,"metrics-enabled":false},"paths":{"/api/inventory-linking/v1/contextual-entities/inventory/{inventoryId}/pages":{"post":{"operationId":"listAllInventoryRelationshipsUsingPOST","summary":"Get List of Relationships","description":"Use this API to get all relationships for an Inventory.","tags":["Inventory Relationships V2"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/platform-inventory.json"},"parameters":[{"name":"inventoryId","in":"path","description":"Inventory ID for which to retrieve contextual links","required":true,"schema":{"type":"string","format":"uuid"},"example":"2aa71ead-0c9a-416a-8471-bdfb67c8d113"},{"name":"page","in":"query","description":"Page number (0-based)","schema":{"type":"integer","default":0,"minimum":0}},{"name":"size","in":"query","description":"Page size (number of records per page)","schema":{"type":"integer","default":20,"maximum":100,"minimum":1}},{"name":"sort","in":"query","description":"Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort parameters are supported.","schema":{"type":"string","example":"createdDate,desc","enum":["name,asc","name,desc","createdDate,asc","createdDate,desc"]}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityListRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseContextualEntityInformation"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["INVENTORY","INVENTORY_READ","INVENTORY_WRITE"]}]}},"/api/inventory-linking/v1/contextual-entities/{contextualLinkId}/contextual-entity-types/names/{entityTypeName}":{"put":{"operationId":"updateInventoryRelationsUsingEntityTypeName_1","summary":"Update Relationship by Type Name","description":"Use this API to modify a contextual link between two entities.","tags":["Inventory Relationships V2"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/platform-inventory.json"},"parameters":[{"name":"entityTypeName","in":"path","description":"Entity type name","required":true,"schema":{"type":"string","enum":["Data Transfer","Representative","Sale of Data","Destination Or Access","Processor","Related","Controller","Collection","Storage Or Processing","Recipient Of Sale","SubProcessor","Product Or Service Provider","Joint Controller","DirectParentChild"],"maxLength":50,"minLength":1},"example":"Data Transfer"},{"name":"contextualLinkId","in":"path","description":"Contextual Link Identifier to be updated","required":true,"schema":{"type":"string","format":"uuid"},"example":"4C09BF9A-38AA-45A9-87BA-77596525849E"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContextualLinkUpdateRequest"}}}},"responses":{"200":{"description":"Relationship successfully updated"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["INVENTORY","INVENTORY_WRITE"]}]}},"/api/inventory-linking/v1/contextual-entities/{contextualLinkId}/contextual-entity-types/names/{entityTypeName}/data-elements":{"put":{"operationId":"linkOrUnlinkInventoryRelationshipsUsingRelationshipUsingPUT_1","summary":"Link or Unlink Personal Data to Relationship by Type Name","description":"Use this API to link or Unlink the personal data to a relationship.","tags":["Inventory Relationships V2"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/platform-inventory.json"},"parameters":[{"name":"entityTypeName","in":"path","description":"Entity type name","required":true,"schema":{"type":"string","maxLength":50,"minLength":1},"example":"vendors"},{"name":"contextualLinkId","in":"path","description":"Contextual Link Identifier","required":true,"schema":{"type":"string","format":"uuid"},"example":"4C09BF9A-38AA-45A9-87BA-77596525849E"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PersonalDataLinkRequest"}},"example":[{"dataElementId":"f2229953-b4b5-4042-8cb9-b78038cc4c46","dataSubjectTypeId":"a1b2c3d4-e5f6-4042-8cb9-b78038cc4c46"}]}}},"responses":{"201":{"description":"Personal data elements successfully linked or unlinked"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["INVENTORY","INVENTORY_WRITE"]}]}},"/api/inventory-linking/v1/contextual-entities/{contextualLinkId}/contextual-entity-types/names/{entityTypeName}/data-elements/pages":{"post":{"operationId":"getPersonalDataForRelationshipsUsingPOST_1","summary":"Get Personal Data for Relationship by Type Name","description":"Use this API to get Personal Data for a Relationship.","tags":["Inventory Relationships V2"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/platform-inventory.json"},"parameters":[{"name":"contextualLinkId","in":"path","description":"Contextual Entity Id","required":true,"schema":{"type":"string","format":"uuid"},"example":"2aa71ead-0c9a-416a-8471-bdfb67c8d113"},{"name":"entityTypeName","in":"path","description":"Entity type name","required":true,"schema":{"type":"string","maxLength":50,"minLength":1},"example":"vendors"},{"name":"page","in":"query","description":"Page number (0-based)","schema":{"type":"integer","default":0,"minimum":0}},{"name":"size","in":"query","description":"Page size (number of records per page)","schema":{"type":"integer","default":20,"maximum":100,"minimum":1}},{"name":"sort","in":"query","description":"Sorting criteria in the format: property(,asc|desc). Default sort order is ascending.","schema":{"type":"string","example":"createdDate,desc","enum":["name,asc","name,desc","createdDate,asc","createdDate,desc"]}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SearchCriteria"}},"example":{"filters":[{"field":"status","operator":"EQ","value":["active"]},{"field":"createdDate","operator":"BETWEEN","date":{"from":"2025-01-01","to":"2025-12-31"}}],"fullText":"John Doe"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PersonalDataDetailedResponse"}}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["INVENTORY","INVENTORY_READ"]}]}},"/api/inventory-linking/v1/contextual-entities/{contextualLinkId}/contextual-entity-types/{entityTypeId}":{"put":{"operationId":"updateInventoryRelationsUsingEntityTypeName","summary":"Update Relationship by Type ID","description":"Use this API to modify a contextual link between two entities.","tags":["Inventory Relationships V2"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/platform-inventory.json"},"parameters":[{"name":"entityTypeId","in":"path","description":"Entity type identifier","required":true,"schema":{"type":"string","format":"uuid"},"example":"2aa71ead-0c9a-416a-8471-bdfb67c8d113"},{"name":"contextualLinkId","in":"path","description":"Contextual Link Identifier to be updated","required":true,"schema":{"type":"string","format":"uuid"},"example":"4C09BF9A-38AA-45A9-87BA-77596525849E"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContextualLinkUpdateRequest"}}}},"responses":{"200":{"description":"Relationship successfully updated"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["INVENTORY","INVENTORY_WRITE"]}]}},"/api/inventory-linking/v1/contextual-entities/{contextualLinkId}/contextual-entity-types/{entityTypeId}/data-elements":{"put":{"operationId":"linkOrUnlinkInventoryRelationshipsUsingRelationshipUsingPUT","summary":"Link or Unlink Personal Data to Relationship by Type ID","description":"Use this API to link or Unlink the personal data to a relationship.","tags":["Inventory Relationships V2"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/platform-inventory.json"},"parameters":[{"name":"entityTypeId","in":"path","description":"Entity type Identifier","required":true,"schema":{"type":"string","format":"uuid"},"example":"2aa71ead-0c9a-416a-8471-bdfb67c8d113"},{"name":"contextualLinkId","in":"path","description":"Contextual Link Identifier","required":true,"schema":{"type":"string","format":"uuid"},"example":"4C09BF9A-38AA-45A9-87BA-77596525849E"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PersonalDataLinkRequest"}},"example":[{"dataElementId":"f2229953-b4b5-4042-8cb9-b78038cc4c46","dataSubjectTypeId":"a1b2c3d4-e5f6-4042-8cb9-b78038cc4c46"}]}}},"responses":{"201":{"description":"Personal data elements successfully linked or unlinked"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["INVENTORY","INVENTORY_WRITE"]}]}},"/api/inventory-linking/v1/contextual-entities/{contextualLinkId}/contextual-entity-types/{entityTypeId}/data-elements/pages":{"post":{"operationId":"getPersonalDataForRelationshipsUsingPOST","summary":"Get Personal Data for Relationship by Type ID","description":"Use this API to get Personal Data for a Relationship.","tags":["Inventory Relationships V2"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/platform-inventory.json"},"parameters":[{"name":"contextualLinkId","in":"path","description":"Contextual Entity Id","required":true,"schema":{"type":"string","format":"uuid"},"example":"2aa71ead-0c9a-416a-8471-bdfb67c8d113"},{"name":"entityTypeId","in":"path","description":"Entity type Identifier","required":true,"schema":{"type":"string","format":"uuid"},"example":"2aa71ead-0c9a-416a-8471-bdfb67c8d113"},{"name":"page","in":"query","description":"Page number (0-based)","schema":{"type":"integer","default":0,"minimum":0}},{"name":"size","in":"query","description":"Page size (number of records per page)","schema":{"type":"integer","default":20,"maximum":100,"minimum":1}},{"name":"sort","in":"query","description":"Sorting criteria in the format: property(,asc|desc). Default sort order is ascending.","schema":{"type":"string","example":"createdDate,desc","enum":["name,asc","name,desc","createdDate,asc","createdDate,desc"]}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SearchCriteria"}},"example":{"filters":[{"field":"status","operator":"EQ","value":["active"]},{"field":"createdDate","operator":"BETWEEN","date":{"from":"2025-01-01","to":"2025-12-31"}}],"fullText":"John Doe"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PersonalDataDetailedResponse"}}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["INVENTORY","INVENTORY_READ"]}]}},"/api/inventory-linking/v1/inventories/relations":{"post":{"operationId":"createInventoryRelationsUsingPOST","summary":"Create Relationship","description":"Use this API to create a bidirectional link between an inventory and one or more other inventories.","tags":["Inventory Relationships V2"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/platform-inventory.json"},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinkRequestDto"}}}},"responses":{"201":{"description":"Relationship created successfully","content":{"application/json":{"schema":{"type":"string","format":"uuid"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["INVENTORY","INVENTORY_WRITE"]}]}},"/api/inventory-linking/v1/relationship":{"post":{"operationId":"addRelationshipBetweenEntitiesUsingPOST","summary":"Create Relationship","description":"Use this API to create a Relationship Record between inventories (Assets, Vendors, Processing Activities, and Entities).","tags":["Relationship Management"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/platform-inventory.json"},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RelationshipCreateRequest"}}}},"responses":{"201":{"description":"Relationship successfully created","content":{"application/json":{"schema":{"description":"UUID of the created relationship","type":"string","format":"uuid","example":"4c09bf9a-38aa-45a9-87ba-77596525849e"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["INVENTORY","INVENTORY_WRITE"]}]}},"/api/inventory-linking/v1/relationship-types/names/{relationshipTypeName}/relationship/{relationshipId}":{"get":{"operationId":"getInventoryRelationshipUsingRelationshipTypeName_1","summary":"Get Relationship by Type Name","description":"Use this API to get relationship details created between entities.","tags":["Inventory Relationships V2"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/platform-inventory.json"},"parameters":[{"name":"relationshipTypeName","in":"path","description":"Relationship Type Name","required":true,"schema":{"type":"string","example":"Data Transfer","enum":["Data Transfer","Representative","Sale of Data","Destination Or Access","Processor","Related","Controller","Collection","Storage Or Processing","Recipient Of Sale","SubProcessor","Product Or Service Provider","Joint Controller","DirectParentChild"]}},{"name":"relationshipId","in":"path","description":"Relationship Identifier","required":true,"schema":{"type":"string","format":"uuid","example":"4C09BF9A-38AA-45A9-87BA-77596525849E"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RelationshipInformation"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["INVENTORY","INVENTORY_READ","INVENTORY_WRITE"]}]},"delete":{"operationId":"deleteInventoryRelationsUsingRelationshipTypeName_1","summary":"Delete Relationship by Type Name","description":"Use this API to remove a contextual link between two entities.","tags":["Inventory Relationships V2"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/platform-inventory.json"},"parameters":[{"name":"relationshipTypeName","in":"path","description":"Relationship type name","required":true,"schema":{"type":"string","example":"Data Transfer","enum":["Data Transfer","Representative","Sale of Data","Destination Or Access","Processor","Related","Controller","Collection","Storage Or Processing","Recipient Of Sale","SubProcessor","Product Or Service Provider","Joint Controller","DirectParentChild"]}},{"name":"relationshipId","in":"path","description":"Relationship Identifier","required":true,"schema":{"type":"string","format":"uuid","example":"4C09BF9A-38AA-45A9-87BA-77596525849E"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["INVENTORY","INVENTORY_WRITE"]}]}},"/api/inventory-linking/v1/relationship-types/{relationshipTypeId}/relationship/{relationshipId}":{"get":{"operationId":"getInventoryRelationshipUsingRelationshipTypeName","summary":"Get Relationship by Type ID","description":"Use this API to get relationship details created between entities.","tags":["Inventory Relationships V2"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/platform-inventory.json"},"parameters":[{"name":"relationshipTypeId","in":"path","description":"Relationship type id","required":true,"schema":{"type":"string","format":"uuid","example":"2aa71ead-0c9a-416a-8471-bdfb67c8d113"}},{"name":"relationshipId","in":"path","description":"Relationship Identifier","required":true,"schema":{"type":"string","format":"uuid","example":"4C09BF9A-38AA-45A9-87BA-77596525849E"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RelationshipInformation"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["INVENTORY","INVENTORY_READ","INVENTORY_WRITE"]}]},"delete":{"operationId":"deleteInventoryRelationsUsingRelationshipTypeName","summary":"Delete Relationship by Type ID","description":"Use this API to remove a contextual link between two entities.","tags":["Inventory Relationships V2"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/platform-inventory.json"},"parameters":[{"name":"relationshipTypeId","in":"path","description":"Relationship type Identifier","required":true,"schema":{"type":"string","format":"uuid","example":"2aa71ead-0c9a-416a-8471-bdfb67c8d113"}},{"name":"relationshipId","in":"path","description":"Relationship Identifier","required":true,"schema":{"type":"string","format":"uuid","example":"4C09BF9A-38AA-45A9-87BA-77596525849E"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["INVENTORY","INVENTORY_WRITE"]}]}}},"components":{"schemas":{"PersonalDataLinkRequest":{"type":"object","properties":{"dataElementId":{"description":"ID of the data element to link/unlink","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"dataSubjectTypeId":{"description":"ID of the data subject type to link/unlink","type":"string","format":"uuid","example":"a1b2c3d4-e5f6-4042-8cb9-b78038cc4c46"}},"example":{"dataElementId":"f2229953-b4b5-4042-8cb9-b78038cc4c46","dataSubjectTypeId":"a1b2c3d4-e5f6-4042-8cb9-b78038cc4c46"}},"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"]},"ContextualLinkUpdateRequest":{"type":"object","properties":{"processingActivityId":{"description":"Processing Activity Id","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"attributes":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/AttributeValueInformation"}},"writeOnly":true}}},"EntityIdAndType":{"type":"object","properties":{"id":{"description":"Entity id","type":"string","format":"uuid","example":"f2229953-b4b5-4042-8cb9-b78038cc4c46"},"type":{"description":"Entity type","type":"string","enum":["assets","processing-activities","vendors","entities","data-elements","data-subj

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