{"openapi":"3.1.0","info":{"title":"Privacy Automation - Data Mapping Automation","version":"1.0","contact":{"name":"OneTrust Support","url":"https://my-onetrust-com.uleth.idm.oclc.org/s/contactsupport"},"license":{"name":"Apache 2.0","url":"https://www.apache.org/licenses/LICENSE-2.0"},"description":"The Data Mapping Automation APIs are used to manage structured records (assets, vendors, processing activities, and legal entities), define schema attributes, traverse parent–child hierarchies, and create cross-record relationships—including links to personal data."},"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","description":"APIs used to create and manage inventory records for supported schema types (processing-activities, vendors, assets, entities).","externalDocs":{"description":"OpenAPI 3.1.0 - Download Definition","url":"https://developer-onetrust-com.uleth.idm.oclc.org/onetrust/openapi/privacy-automation-data-mapping-automation.json"}},{"name":"Inventory Hierarchies","description":"APIs used to list, link, and unlink child inventories under a root inventory to model organizational or data-flow trees.","externalDocs":{"description":"OpenAPI 3.1.0 - Download Definition","url":"https://developer-onetrust-com.uleth.idm.oclc.org/onetrust/openapi/privacy-automation-data-mapping-automation.json"}},{"name":"Inventory Relationships V1","description":"APIs used to create, update, and delete bidirectional links between inventories and to manage associations to related items (including personal data).","externalDocs":{"description":"OpenAPI 3.1.0 - Download Definition","url":"https://developer-onetrust-com.uleth.idm.oclc.org/onetrust/openapi/privacy-automation-data-mapping-automation.json"}},{"name":"Inventory Schema","description":"APIs used to define and maintain schema attributes that shape inventory data collection and validation.","externalDocs":{"description":"OpenAPI 3.1.0 - Download Definition","url":"https://developer-onetrust-com.uleth.idm.oclc.org/onetrust/openapi/privacy-automation-data-mapping-automation.json"}},{"name":"Personal Data","description":"APIs used to list links to personal-data items for an inventory and update advanced attributes on those associations.","externalDocs":{"description":"OpenAPI 3.1.0 - Download Definition","url":"https://developer-onetrust-com.uleth.idm.oclc.org/onetrust/openapi/privacy-automation-data-mapping-automation.json"}}],"x-onetrust":{"spec-label":"OpenAPI 3.1.0","links":["{'Data Mapping Automation Knowledge Base': 'https://my-onetrust-com.uleth.idm.oclc.org/s/topic/0TO1Q000000ItRxWAK/data-mapping-automation'}"]},"x-readme":{"explorer-enabled":false,"proxy-enabled":false,"metrics-enabled":false},"paths":{"/api/inventory/v2/data-categories":{"get":{"operationId":"getDataCategoriesByPartialNameUsingGET","summary":"Get List of Data Categories","description":"Use this API to retrieve a list of all existing Data Categories.","tags":["Personal Data"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.uleth.idm.oclc.org/onetrust/openapi/privacy-automation-data-mapping-automation.json"},"parameters":[{"name":"filter","in":"query","description":"Optional filter string to search data categories by name","required":false,"schema":{"type":"string"},"example":"Financial"},{"name":"page","in":"query","description":"Results page to be retrieved (0..N)","schema":{"type":"integer","format":"int32","default":0,"minimum":0},"example":0},{"name":"size","in":"query","description":"Number of records per page (1..50)","schema":{"type":"integer","format":"int32","default":20,"maximum":50,"minimum":1},"example":20},{"name":"sort","in":"query","description":"Sorting criteria in the format: property(,asc|desc). Default sort order is ascending","schema":{"type":"string","enum":["name,asc","name,desc","createdDate,asc","createdDate,desc"]},"example":"name,asc"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataCategoryResponse"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.uleth.idm.oclc.org/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"]}]},"post":{"operationId":"createDataCategoryUsingPOST","summary":"Create Data Category","description":"Use this API to to create new Data Categories in Data Mapping Automation module.","tags":["Personal Data"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.uleth.idm.oclc.org/onetrust/openapi/privacy-automation-data-mapping-automation.json"},"parameters":[{"name":"generator","in":"query","description":"Optional generator parameter","required":false,"schema":{"type":"string"},"example":"system"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataCategoryCreateUpdateRequest"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataCategoryResponse"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.uleth.idm.oclc.org/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/v2/data-categories/{id}":{"get":{"operationId":"getDataCategoryUsingGET","summary":"Get Data Category","description":"Use this API to provide the details of a single Data Category by ID.","tags":["Personal Data"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.uleth.idm.oclc.org/onetrust/openapi/privacy-automation-data-mapping-automation.json"},"parameters":[{"name":"id","in":"path","description":"The ID of the data category to retrieve","required":true,"schema":{"type":"string","format":"uuid"},"example":"43fd3a8d-3f6b-464e-bf43-3f0c6c592442"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataCategoryResponse"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.uleth.idm.oclc.org/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":"deleteDataCategoryUsingDELETE","summary":"Delete Data Category","description":"Use this API to delete Data Categories within the Data Mapping Automation Module of OneTrust. To successfully delete a data category, there must be no data-elements assigned to the data category.","tags":["Personal Data"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.uleth.idm.oclc.org/onetrust/openapi/privacy-automation-data-mapping-automation.json"},"parameters":[{"name":"id","in":"path","description":"The ID of the data category to delete","required":true,"schema":{"type":"string","format":"uuid"},"example":"43fd3a8d-3f6b-464e-bf43-3f0c6c592442"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.uleth.idm.oclc.org/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"]}]}},"/api/inventory/v2/data-classifications":{"post":{"operationId":"createDataClassificationUsingPOST","summary":"Create Data Classification","description":"Use this API to create new Data Mapping Automation-Data Classification.","tags":["Personal Data"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.uleth.idm.oclc.org/onetrust/openapi/privacy-automation-data-mapping-automation.json"},"parameters":[{"name":"generator","in":"query","description":"Optional generator parameter","required":false,"schema":{"type":"string"},"example":"system"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataClassificationCreateUpdateRequest"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataClassificationResponse"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.uleth.idm.oclc.org/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/v2/data-classifications/{id}":{"get":{"operationId":"getDataClassificationUsingGET","summary":"Get Data Classification","description":"Use this API to retrieve the details of a single Data Classification by ID.","tags":["Personal Data"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.uleth.idm.oclc.org/onetrust/openapi/privacy-automation-data-mapping-automation.json"},"parameters":[{"name":"id","in":"path","description":"The ID of the data classification to retrieve","required":true,"schema":{"type":"string","format":"uuid"},"example":"43fd3a8d-3f6b-464e-bf43-3f0c6c592442"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataClassificationResponse"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.uleth.idm.oclc.org/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":"deleteDataClassificationUsingDELETE","summary":"Delete Data Classification","description":"Use this API to delete a data category, the Data Classification ID must be provided in the URL path.","tags":["Personal Data"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.uleth.idm.oclc.org/onetrust/openapi/privacy-automation-data-mapping-automation.json"},"parameters":[{"name":"id","in":"path","description":"The ID of the data classification to delete","required":true,"schema":{"type":"string","format":"uuid"},"example":"43fd3a8d-3f6b-464e-bf43-3f0c6c592442"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.uleth.idm.oclc.org/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"]}]}},"/api/inventory/v2/data-elements":{"post":{"operationId":"createDataElementUsingPOST","summary":"Create Data Element","description":"Use this API to create new Data Elements in Data Mapping Automation module.","tags":["Personal Data"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.uleth.idm.oclc.org/onetrust/openapi/privacy-automation-data-mapping-automation.json"},"parameters":[{"name":"generator","in":"query","description":"Optional generator parameter","required":false,"schema":{"type":"string"},"example":"system"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataElementCreateRequest"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataElementDetailedResponse"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.uleth.idm.oclc.org/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/v2/data-elements/{id}":{"get":{"operationId":"getDataElementUsingGET","summary":"Get Data Element","description":"Use this API to retrieve the details of a single Data Element by ID.","tags":["Personal Data"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.uleth.idm.oclc.org/onetrust/openapi/privacy-automation-data-mapping-automation.json"},"parameters":[{"name":"id","in":"path","description":"The ID of the data element to retrieve","required":true,"schema":{"type":"string","format":"uuid"},"example":"43fd3a8d-3f6b-464e-bf43-3f0c6c592442"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataElementDetailedResponse"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.uleth.idm.oclc.org/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":"deleteDataElementUsingDELETE","summary":"Delete Data Element","description":"Use this API to delete a data element.","tags":["Personal Data"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.uleth.idm.oclc.org/onetrust/openapi/privacy-automation-data-mapping-automation.json"},"parameters":[{"name":"id","in":"path","description":"The ID of the data element to delete","required":true,"schema":{"type":"string","format":"uuid"},"example":"43fd3a8d-3f6b-464e-bf43-3f0c6c592442"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.uleth.idm.oclc.org/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"]}]}},"/api/inventory/v2/data-subjects":{"get":{"operationId":"getDataSubjectsByPartialNameUsingGET","summary":"Get List of Data Subjects","description":"Use this API to retrieve the list of all existing Data Subjects.","tags":["Personal Data"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.uleth.idm.oclc.org/onetrust/openapi/privacy-automation-data-mapping-automation.json"},"parameters":[{"name":"filter","in":"query","description":"Optional filter string to search data subjects by name","required":false,"schema":{"type":"string"},"example":"Customer"},{"name":"page","in":"query","description":"Results page to be retrieved (0..N)","schema":{"type":"integer","format":"int32","default":0,"minimum":0},"example":0},{"name":"size","in":"query","description":"Number of records per page (1..50)","schema":{"type":"integer","format":"int32","default":20,"maximum":50,"minimum":1},"example":20},{"name":"sort","in":"query","description":"Sorting criteria in the format: property(,asc|desc). Default sort order is ascending","schema":{"type":"string","enum":["name,asc","name,desc","createdDate,asc","createdDate,desc"]},"example":"name,asc"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataSubjectResponse"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.uleth.idm.oclc.org/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"]}]},"post":{"operationId":"createDataSubjectUsingPOST","summary":"Create Data Subject","description":"Use this API to create new Data Subject in the Data Mapping Automation Module.","tags":["Personal Data"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.uleth.idm.oclc.org/onetrust/openapi/privacy-automation-data-mapping-automation.json"},"parameters":[{"name":"generator","in":"query","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataSubjectCreateUpdateRequest"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataSubjectResponse"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.uleth.idm.oclc.org/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/v2/data-subjects/{id}":{"get":{"operationId":"getDataSubjectUsingGET","summary":"Get Data Subject","description":"Use this API to retrieve the details of a single Data Subject by ID.","tags":["Personal Data"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.uleth.idm.oclc.org/onetrust/openapi/privacy-automation-data-mapping-automation.json"},"parameters":[{"name":"id","in":"path","description":"The ID of the Data Subject","required":true,"schema":{"type":"string","format":"uuid"},"example":"43fd3a8d-3f6b-464e-bf43-3f0c6c592442"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataSubjectResponse"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.uleth.idm.oclc.org/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":"deleteDataSubjectUsingDELETE","summary":"Delete Data Subject","description":"Use this API to delete a data element.","tags":["Personal Data"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.uleth.idm.oclc.org/onetrust/openapi/privacy-automation-data-mapping-automation.json"},"parameters":[{"name":"id","in":"path","description":"The ID of the data subject to delete","required":true,"schema":{"type":"string","format":"uuid"},"example":"43fd3a8d-3f6b-464e-bf43-3f0c6c592442"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.uleth.idm.oclc.org/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"]}]}},"/api/inventory/v2/inventories/{id}/associations/{associationId}":{"put":{"operationId":"updateInventoryAssociationUsingPUT","summary":"Update Inventory Link","description":"Use this API to update a bidirectional link between two inventories.","tags":["Inventory Relationships V1"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.uleth.idm.oclc.org/onetrust/openapi/privacy-automation-data-mapping-automation.json"},"parameters":[{"name":"id","in":"path","description":"The unique identifier of an inventory record","required":true,"schema":{"type":"string","format":"uuid"},"example":"43fd3a8d-3f6b-464e-bf43-3f0c6c592442"},{"name":"associationId","in":"path","description":"The unique identifier of the association","required":true,"schema":{"type":"string","format":"uuid"},"example":"4374d5da-44ac-4308-a298-3efdb0f34ba4"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InventoryAssociationRequest"}}}},"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.uleth.idm.oclc.org/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/v2/inventories/{id}/relations":{"put":{"operationId":"updateRelationsUsingPUT","summary":"Link Inventory","description":"Use this API to create a bidirectional link between an inventory and one or more other inventories.","tags":["Inventory Relationships V1"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.uleth.idm.oclc.org/onetrust/openapi/privacy-automation-data-mapping-automation.json"},"parameters":[{"name":"id","in":"path","description":"The unique identifier of an inventory record","required":true,"schema":{"type":"string","format":"uuid"},"example":"43fd3a8d-3f6b-464e-bf43-3f0c6c592442"},{"name":"entityType","in":"query","description":"Entity type parameter","required":false,"schema":{"type":"string","enum":["processing-activities","vendors","assets","entities"]},"example":"vendors"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InventoryAssociationUpdateRequest"}}}}},"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.uleth.idm.oclc.org/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":[]}]},"post":{"operationId":"createRelationsUsingPOST","summary":"Link Inventory","description":"Use this API to create a bidirectional link between an inventory and one or more other inventories.","tags":["Inventory Relationships V1"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.uleth.idm.oclc.org/onetrust/openapi/privacy-automation-data-mapping-automation.json"},"parameters":[{"name":"id","in":"path","description":"The unique identifier of an inventory record. The value can be obtained using the [List Inventories](/onetrust/reference/getInventoryList) API.","required":true,"schema":{"type":"string","format":"uuid"},"example":"43fd3a8d-3f6b-464e-bf43-3f0c6c592442"},{"name":"entityType","in":"query","description":"Entity type parameter","required":false,"schema":{"type":"string","enum":["processing-activities","vendors","assets","entities"]},"example":"vendors"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InventoryAssociationCreateRequest"}},"example":"[\n {\n \"id\": \"d31425ae-1321-4738-bb76-bdca83c0944c\"\n \"relation\": \"SourceCollectionLinkType\"\n }\n]"}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BaseInventoryAssociationDto"}},"example":[{"inventoryId":"d31425ae-1321-4738-bb76-bdca83c0944c","inventoryAssociationId":"3cdcd5b1-7960-4e7d-b212-641975fe2b12"}]}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.uleth.idm.oclc.org/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"]}]},"delete":{"operationId":"deleteRelationsUsingDELETE","summary":"Delete Inventory Link","description":"Use this API to permanently delete a link between an inventory and one or more other inventories.","tags":["Inventory Relationships V1"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.uleth.idm.oclc.org/onetrust/openapi/privacy-automation-data-mapping-automation.json"},"parameters":[{"name":"id","in":"path","description":"The unique identifier of an inventory record. The value can be obtained using the [List Inventories](/onetrust/reference/getInventoryList) API.","required":true,"schema":{"type":"string","format":"uuid"},"example":"43fd3a8d-3f6b-464e-bf43-3f0c6c592442"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InventoryAssociationRemoveRequest"}},"example":[{"inventoryAssociationId":"d31425ae-1321-4738-bb76-bdca83c0944c"}]}}},"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.uleth.idm.oclc.org/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/v2/inventories/{id}/relations/{inventoryType}":{"get":{"operationId":"getInventoryRelationsByIdUsingGET","summary":"Get Inventory Links","description":"Use this API to list an existing links between an inventory and one or more other inventories of a given type.","tags":["Inventory Relationships V1"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.uleth.idm.oclc.org/onetrust/openapi/privacy-automation-data-mapping-automation.json"},"parameters":[{"name":"id","in":"path","description":"The unique identifier of an inventory record. The value can be obtained using the [List Inventories](/onetrust/reference/getInventoryList) API.","required":true,"schema":{"type":"string","format":"uuid"},"example":"43fd3a8d-3f6b-464e-bf43-3f0c6c592442"},{"name":"inventoryType","in":"path","description":"The type of inventory records to check relations for.","required":true,"schema":{"type":"string","enum":["processing-activities","vendors","assets","entities","data-elements"]},"example":"vendors"},{"name":"page","in":"query","description":"Results page to be retrieved (0..N)","schema":{"type":"integer","format":"int32","default":0,"minimum":0},"example":0},{"name":"size","in":"query","description":"Number of records per page (1..50)","schema":{"type":"integer","format":"int32","default":20,"maximum":50,"minimum":1},"example":20}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BaseInventoryAssociationDto"}},"example":{"data":[{"inventoryId":"9a7c3ec1-7830-4811-8563-36e0a093e7ae","inventoryAssociationId":"4374d5da-44ac-4308-a298-3efdb0f34ba4","inventoryType":"vendors","anchorInventoryId":"ba1d8b56-98e3-438b-a24d-cc4a8b282f93","inventoryAssociationTypeKey":"JointControllerLinkType","inventoryAssociationType":"JointController","name":"Vendorrecord","organization":"aws","organizationId":"01d5d6db-a3f0-424e-9956-cfa205dc8af7","type":"Operations","typeKey":"VendorsTypeOperations","editable":true}],"meta":{"page":{"first":true,"last":true,"number":0,"size":20,"totalElements":1,"totalPages":1}}}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.uleth.idm.oclc.org/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/v2/inventories/{inventoryId}/set-as-parent":{"put":{"operationId":"setInventoryAsParentInventoryUsingPUT","summary":"Set Inventory as Parent","description":"Use this API to set an existing inventory as a Parent inventory.","tags":["Inventory Hierarchies"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.uleth.idm.oclc.org/onetrust/openapi/privacy-automation-data-mapping-automation.json"},"parameters":[{"name":"inventoryId","in":"path","description":"The unique identifier of the inventory to set as parent","required":true,"schema":{"type":"string","format":"uuid"},"example":"c4bee781-912b-4328-8851-6f906afd7ccb"},{"name":"inventoryType","in":"query","description":"The type of inventory (e.g., assets, vendors, processing-activities, legal-entities)","required":true,"schema":{"type":"string","enum":["processing-activities","vendors","assets","entities"]},"example":"assets"}],"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.uleth.idm.oclc.org/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/v2/inventories/{inventoryId}/unset-as-parent":{"put":{"operationId":"unsetInventoryAsParentInventoryUsingPUT","summary":"Unset Inventory as Parent","description":"Use this API to unset an existing inventory from being a Parent inventory.","tags":["Inventory Hierarchies"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.uleth.idm.oclc.org/onetrust/openapi/privacy-automation-data-mapping-automation.json"},"parameters":[{"name":"inventoryId","in":"path","description":"The unique identifier of the inventory to unset as parent","required":true,"schema":{"type":"string","format":"uuid"},"example":"c4bee781-912b-4328-8851-6f906afd7ccb"},{"name":"inventoryType","in":"query","description":"The type of inventory (e.g., assets, vendors, processing-activities, legal-entities)","required":true,"schema":{"type":"string","enum":["processing-activities","vendors","assets","entities"]},"example":"assets"}],"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.uleth.idm.oclc.org/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/v2/inventories/{parentInventoryId}/link-assets":{"post":{"operationId":"linkAssetInventoryToParentAssetIdUsingPOST","summary":"Add Asset Inventory as Child to Parent Inventory","description":"Use this API to link an existing asset inventory as a child inventory to a parent asset inventory.","tags":["Inventory Hierarchies"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.uleth.idm.oclc.org/onetrust/openapi/privacy-automation-data-mapping-automation.json"},"parameters":[{"name":"parentInventoryId","in":"path","description":"The unique identifier of the parent asset inventory","required":true,"schema":{"type":"string","format":"uuid"},"example":"96214230-ffbb-4870-b6c4-0f30c3bfec60"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"string","format":"uuid"}},"examples":{"childInventoryIds":{"description":"childInventoryIds","value":["96214230-ffbb-4870-b6c4-0f30c3bfec60","a1b2c3d4-e5f6-7890-abcd-ef1234567890"]}}}}},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.uleth.idm.oclc.org/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/v2/inventories/{parentInventoryId}/link-legal-entities":{"post":{"operationId":"linkLegalEntityInventoryToParentLegalEntityIdUsingPOST","summary":"Add Legal Entity Inventory as Child to Parent Inventory","description":"Use this API to link an existing legal entity inventory as a child inventory to a parent legal entity inventory.","tags":["Inventory Hierarchies"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.uleth.idm.oclc.org/onetrust/openapi/privacy-automation-data-mapping-automation.json"},"parameters":[{"name":"parentInventoryId","in":"path","description":"The unique identifier of the parent legal entity inventory","required":true,"schema":{"type":"string","format":"uuid"},"example":"96214230-ffbb-4870-b6c4-0f30c3bfec60"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"string","format":"uuid"}},"examples":{"childInventoryIds":{"description":"childInventoryIds","value":["96214230-ffbb-4870-b6c4-0f30c3bfec60","a1b2c3d4-e5f6-7890-abcd-ef1234567890"]}}}}},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.uleth.idm.oclc.org/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/v2/inventories/{parentInventoryId}/link-processing-activities":{"post":{"operationId":"linkProcessingActivityInventoryToParentProcessingActivityIdUsingPOST","summary":"Add Processing Activity Inventory as Child to Parent Inventory","description":"Use this API to link an existing processing activity inventory as a child inventory to a parent processing activity inventory.","tags":["Inventory Hierarchies"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.uleth.idm.oclc.org/onetrust/openapi/privacy-automation-data-mapping-automation.json"},"parameters":[{"name":"parentInventoryId","in":"path","description":"The unique identifier of the parent processing activity inventory","required":true,"schema":{"type":"string","format":"uuid"},"example":"96214230-ffbb-4870-b6c4-0f30c3bfec60"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"string","format":"uuid"}},"examples":{"childInventoryIds":{"description":"childInventoryIds","value":["96214230-ffbb-4870-b6c4-0f30c3bfec60","a1b2c3d4-e5f6-7890-abcd-ef1234567890"]}}}}},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.uleth.idm.oclc.org/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/v2/inventories/{parentInventoryId}/link-vendors":{"post":{"operationId":"linkVendorInventoryToParentVendorIdUsingPOST","summary":"Add Vendor Inventory as Child to Parent Inventory","description":"Use this API to link an existing vendor inventory as a child inventory to a parent vendor inventory.","tags":["Inventory Hierarchies"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.uleth.idm.oclc.org/onetrust/openapi/privacy-automation-data-mapping-automation.json"},"parameters":[{"name":"parentInventoryId","in":"path","description":"The unique identifier of the parent vendor inventory","required":true,"schema":{"type":"string","format":"uuid"},"example":"96214230-ffbb-4870-b6c4-0f30c3bfec60"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"description":"List of child vendor inventory IDs to link to the parent","type":"array","format":"uuid"}}}},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.uleth.idm.oclc.org/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/v2/inventories/{schemaName}":{"get":{"operationId":"getListOfInventoriesUsingGET","summary":"Get List of Inventories","description":"Use this API to retrieve a paginated list of inventories for a given type.","tags":["Inventory"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.uleth.idm.oclc.org/onetrust/openapi/privacy-automation-data-mapping-automation.json"},"parameters":[{"name":"schemaName","in":"path","description":"The `name` property of the schema. The value can be obtained using the [Get Schemas](/onetrust/reference/getSchemas) API.","required":true,"schema":{"type":"string","enum":["processing-activities","vendors","assets","entities"]},"example":"vendors"},{"name":"filter","in":"query","description":"Filter string for searching inventories. Format: 'searchText=value'.","required":false,"schema":{"type":"string"},"example":"searchText=Server"},{"name":"markForDelete","in":"query","description":"Flag to include soft-deleted inventories.","required":false,"schema":{"type":"boolean","default":false},"example":false},{"name":"page","in":"query","description":"Results page to be retrieved (0..N)","schema":{"type":"integer","format":"int32","default":0,"minimum":0},"example":0},{"name":"size","in":"query","description":"Number of records per page (1..50)","schema":{"type":"integer","format":"int32","default":20,"maximum":50,"minimum":1},"example":20}],"responses":{"200":{"description":"OK - Successfully retrieved inventory list.","content":{"application/json":{"schema":{"type":"object","oneOf":[{"$ref":"#/components/schemas/VendorInventoriesPaginatedListResponse"},{"$ref":"#/components/schemas/AssetInventoriesPaginatedListResponse"},{"$ref":"#/components/schemas/EntityInventoriesPaginatedListResponse"},{"$ref":"#/components/schemas/InventoriesPaginatedListResponse"}]},"examples":{"vendors":{"summary":"Vendor Inventories Paginated Response","description":"vendors","value":{"data":[{"id":"9a7c3ec1-7830-4811-8563-36e0a093e7ae","name":"Vendor Name","organization":{"value":"aws","id":"01d5d6db-a3f0-424e-9956-cfa205dc8af7"},"type":{"value":"Operations","id":"a9e976c7-f643-4e3c-94c6-edec5d0279a9","valueKey":"VendorsTypeOperations"},"isEditable":true,"isDeletable":true,"canViewDetails":true,"status":{"key":"active"},"number":1,"isParent":false}],"meta":{"page":{"first":true,"last":true,"number":0,"size":20,"totalElements":1,"totalPages":1,"sort":[{"direction":"ASC","property":"name"}]}}}},"assets":{"summary":"Asset Inventories Paginated Response","description":"assets","value":{"data":[{"id":"9a7c3ec1-7830-4811-8563-36e0a093e7ae","name":"Asset Name","organization":{"value":"aws","id":"01d5d6db-a3f0-424e-9956-cfa205dc8af7"},"location":{"value":"US East","id":"b2c4d6e8-1234-5678-9abc-def012345678"},"isEditable":true,"isDeletable":true,"canViewDetails":true,"status":{"key":"active"},"number":2,"isParent":false}],"meta":{"page":{"first":true,"last":true,"number":0,"size":20,"totalElements":1,"totalPages":1,"sort":[{"direction":"ASC","property":"name"}]}}}},"processing-activities":{"summary":"Processing Activity Inventories Paginated Response","description":"processing-activities","value":{"data":[{"id":"9a7c3ec1-7830-4811-8563-36e0a093e7ae","name":"Processing Activity Name","organization":{"value":"aws","id":"01d5d6db-a3f0-424e-9956-cfa205dc8af7"},"isEditable":true,"isDeletable":true,"canViewDetails":true,"status":{"key":"active"},"number":3,"isParent":false}],"meta":{"page":{"first":true,"last":true,"number":0,"size":20,"totalElements":1,"totalPages":1,"sort":[{"direction":"ASC","property":"name"}]}}}},"entities":{"summary":"Entity Inventories Paginated Response","description":"entities","value":{"data":[{"id":"9a7c3ec1-7830-4811-8563-36e0a093e7ae","name":"Entity Name","organization":{"value":"aws","id":"01d5d6db-a3f0-424e-9956-cfa205dc8af7"},"primaryOperatingLocation":{"value":"US East","id":"b2c4d6e8-1234-5678-9abc-def012345678"},"isEditable":true,"isDeletable":true,"canViewDetails":true,"status":{"key":"active"},"number":4,"isParent":false}],"meta":{"page":{"first":true,"last":true,"number":0,"size":20,"totalElements":1,"totalPages":1,"sort":[{"direction":"ASC","property":"name"}]}}}}}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.uleth.idm.oclc.org/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"]}]},"post":{"operationId":"createInventoryUsingPOST","summary":"Create Inventory","description":"Use this API to create an inventory of a particular type.","tags":["Inventory"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.uleth.idm.oclc.org/onetrust/openapi/privacy-automation-data-mapping-automation.json"},"parameters":[{"name":"schemaName","in":"path","description":"The `name` property of the schema.","required":true,"schema":{"type":"string","enum":["processing-activities","vendors","assets","entities"]},"example":"vendors"},{"name":"generator","in":"query","description":"Optional generator type for the create operation.","required":false,"schema":{"type":"string"},"example":"API_INTEGRATION"},{"name":"createAsMaster","in":"query","description":"Flag to create the inventory as a master record.","required":false,"schema":{"type":"boolean","default":false},"example":false},{"name":"sourceId","in":"query","description":"Optional source inventory UUID to copy from.","required":false,"schema":{"type":"string","format":"uuid"},"example":"c79fb1a9-9406-4e9b-bff7-c72e635ee82b"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"string","oneOf":[{"$ref":"#/components/schemas/AssetInventoryCreateRequest"},{"$ref":"#/components/schemas/VendorInventoryCreateRequest"},{"$ref":"#/components/schemas/EntityInventoryCreateRequest"},{"$ref":"#/components/schemas/PAInventoryCreateRequest"}]},"examples":{"vendors":{"summary":"Vendor Create Request","description":"vendors","value":{"name":"Test Vendor","organization":{"value":"aws","id":"aebedb42-a4fe-4768-aac7-7be1b4c17184"},"type":{"id":"cc11c8a5-bbb3-4377-a33d-52a23b1455f9","value":"Regulatory","seeded":true,"sequence":0}}},"assets":{"summary":"Asset Create Request","description":"assets","value":{"name":"Test Asset","organization":{"value":"aws","id":"aebedb42-a4fe-4768-aac7-7be1b4c17184"},"location":{"value":"US East","id":"b2c4d6e8-1234-5678-9abc-def012345678"}}},"entities":{"summary":"Entity Create Request","description":"entities","value":{"name":"Test Entity","organization":{"value":"aws","id":"aebedb42-a4fe-4768-aac7-7be1b4c17184"},"primaryOperatingLocation":{"value":"US East","id":"b2c4d6e8-1234-5678-9abc-def012345678"}}},"processing-activities":{"summary":"Processing Activity Create Request","description":"processing-activities","value":{"name":"Test Processing Activity","organization":{"value":"aws","id":"aebedb42-a4fe-4768-aac7-7be1b4c17184"}}}}}}},"responses":{"201":{"description":"Created - Inventory successfully created.","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/OneTrustResponse"},"example":{"data":{"id":"c79fb1a9-9406-4e9b-bff7-c72e635ee82b"}}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.uleth.idm.oclc.org/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/v2/inventories/{schemaName}/business-key":{"put":{"operationId":"upsertInventoryUsingPUT","summary":"Update Inventory by External ID","description":"Use this API to update the Inventory if already exists or create a new Inventory otherwise.\n\n### Example Request\n\n`PUT https://{hostname}/api/inventory/v2/inventories/{type}/reference/{externalId}`\n\n`PUT https://trial-onetrust-com.uleth.idm.oclc.org/api/inventory/v2/inventories/vendors/reference/43fd3a8d-3f6b-464e-bf43-3f0c6c592442`","tags":["Inventory"],"parameters":[{"name":"schemaName","in":"path","description":"The `name` property of the schema.","required":true,"schema":{"type":"string","enum":["processing-activities","vendors","assets","entities"]},"example":"vendors"},{"name":"generator","in":"query","description":"Optional generator type for the operation.","required":false,"schema":{"type":"string"},"example":"API_INTEGRATION"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"string","oneOf":[{"$ref":"#/components/schemas/AssetInventoryCreateRequest"},{"$ref":"#/components/schemas/VendorInventoryCreateRequest"},{"$ref":"#/components/schemas/EntityInventoryCreateRequest"},{"$ref":"#/components/schemas/PAInventoryCreateRequest"}]},"examples":{"vendors":{"summary":"Vendor Upsert Request","description":"vendors","value":{"name":"Test Vendor","organization":{"value":"aws","id":"aebedb42-a4fe-4768-aac7-7be1b4c17184"},"type":{"id":"cc11c8a5-bbb3-4377-a33d-52a23b1455f9","value":"Regulatory","seeded":true,"sequence":0}}},"assets":{"summary":"Asset Upsert Request","description":"assets","value":{"name":"Test Asset","organization":{"value":"aws","id":"aebedb42-a4fe-4768-aac7-7be1b4c17184"},"location":{"value":"US East","id":"b2c4d6e8-1234-5678-9abc-def012345678"}}},"entities":{"summary":"Entity Upsert Request","description":"entities","value":{"name":"Test Entity","organization":{"value":"aws","id":"aebedb42-a4fe-4768-aac7-7be1b4c17184"},"primaryOperatingLocation":{"value":"US East","id":"b2c4d6e8-1234-5678-9abc-def012345678"}}},"processing-activities":{"summary":"Processing Activity Upsert Request","description":"processing-activities","value":{"name":"Test Processing Activity","organization":{"value":"aws","id":"aebedb42-a4fe-4768-aac7-7be1b4c17184"}}}}}}},"responses":{"200":{"description":"OK - Inventory successfully created or updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkUpsertInventoryResponse"},"example":{"data":{"id":"c79fb1a9-9406-4e9b-bff7-c72e635ee82b","name":"Updated Inventory","externalId":"ext-123"}}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.uleth.idm.oclc.org/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/v2/inventories/{schemaName}/criteria":{"post":{"operationId":"getListOfInventoriesByFilterCriteriaUsingPOST","summary":"Get List of Inventories by Criteria","description":"Use this API to retrieve the list of inventories for a given type by filter criteria.","tags":["Inventory"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.uleth.idm.oclc.org/onetrust/openapi/privacy-automation-data-mapping-automation.json"},"parameters":[{"name":"schemaName","in":"path","description":"The `name` property of the schema.","required":true,"schema":{"type":"string","enum":["processing-activities","vendors","assets","entities"]},"example":"vendors"},{"name":"markForDelete","in":"query","description":"Flag to include soft-deleted inventories.","required":false,"schema":{"type":"boolean","default":false},"example":false},{"name":"page","in":"query","description":"Results page to be retrieved (0..N)","schema":{"type":"integer","format":"int32","default":0,"minimum":0},"example":0},{"name":"size","in":"query","description":"Number of records per page (1..50)","schema":{"type":"integer","format":"int32","default":20,"maximum":50,"minimum":1},"example":20}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BasicInventoryFilterRequest"}}}},"responses":{"200":{"description":"OK - Successfully retrieved filtered inventory list.","content":{"application/json":{"schema":{"type":"object","oneOf":[{"$ref":"#/components/schemas/VendorInventoriesPaginatedListResponse"},{"$ref":"#/components/schemas/AssetInventoriesPaginatedListResponse"},{"$ref":"#/components/schemas/EntityInventoriesPaginatedListResponse"},{"$ref":"#/components/schemas/InventoriesPaginatedListResponse"}]},"examples":{"vendors":{"summary":"Vendor Inventories Paginated Response","description":"vendors","value":{"data":[{"id":"9a7c3ec1-7830-4811-8563-36e0a093e7ae","name":"Vendor Name","organization":{"value":"aws","id":"01d5d6db-a3f0-424e-9956-cfa205dc8af7"},"type":{"value":"Operations","id":"a9e976c7-f643-4e3c-94c6-edec5d0279a9","valueKey":"VendorsTypeOperations"},"isEditable":true,"isDeletable":true,"canViewDetails":true,"status":{"key":"active"},"number":1,"isParent":false}],"meta":{"page":{"first":true,"last":true,"number":0,"size":20,"totalElements":1,"totalPages":1,"sort":[{"direction":"ASC","property":"name"}]}}}},"assets":{"summary":"Asset Inventories Paginated Response","description":"assets","value":{"data":[{"id":"9a7c3ec1-7830-4811-8563-36e0a093e7ae","name":"Asset Name","organization":{"value":"aws","id":"01d5d6db-a3f0-424e-9956-cfa205dc8af7"},"location":{"value":"US East","id":"b2c4d6e8-1234-5678-9abc-def012345678"},"isEditable":true,"isDeletable":true,"canViewDetails":true,"status":{"key":"active"},"number":2,"isParent":false}],"meta":{"page":{"first":true,"last":true,"number":0,"size":20,"totalElements":1,"totalPages":1,"sort":[{"direction":"ASC","property":"name"}]}}}},"processing-activities":{"summary":"Processing Activity Inventories Paginated Response","description":"processing-activities","value":{"data":[{"id":"9a7c3ec1-7830-4811-8563-36e0a093e7ae","name":"Processing Activity Name","organization":{"value":"aws","id":"01d5d6db-a3f0-424e-9956-cfa205dc8af7"},"isEditable":true,"isDeletable":true,"canViewDetails":true,"status":{"key":"active"},"number":3,"isParent":false}],"meta":{"page":{"first":true,"last":true,"number":0,"size":20,"totalElements":1,"totalPages":1,"sort":[{"direction":"ASC","property":"name"}]}}}},"entities":{"summary":"Entity Inventories Paginated Response","description":"entities","value":{"data":[{"id":"9a7c3ec1-7830-4811-8563-36e0a093e7ae","name":"Entity Name","organization":{"value":"aws","id":"01d5d6db-a3f0-424e-9956-cfa205dc8af7"},"primaryOperatingLocation":{"value":"US East","id":"b2c4d6e8-1234-5678-9abc-def012345678"},"isEditable":true,"isDeletable":true,"canViewDetails":true,"status":{"key":"active"},"number":4,"isParent":false}],"meta":{"page":{"first":true,"last":true,"number":0,"size":20,"totalElements":1,"totalPages":1,"sort":[{"direction":"ASC","property":"name"}]}}}}}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.uleth.idm.oclc.org/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/v2/inventories/{schemaName}/reference/{externalId}":{"get":{"operationId":"getInventoryByExternalIdUsingGET","summary":"Get Inventory by External ID","description":"Use this API to retrieve the inventory by external ID.","tags":["Inventory"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.uleth.idm.oclc.org/onetrust/openapi/privacy-automation-data-mapping-automation.json"},"parameters":[{"name":"schemaName","in":"path","description":"The `name` property of the schema. The value can be obtained using the [Get Schemas](/onetrust/reference/getSchemas) API.","required":true,"schema":{"type":"string","enum":["processing-activities","vendors","assets","entities"]},"example":"vendors"},{"name":"externalId","in":"path","description":"The external identifier of the inventory item.","required":true,"schema":{"type":"string"},"example":"vendor-ext-001"}],"responses":{"200":{"description":"OK - Successfully retrieved inventory by external ID.","content":{"application/json":{"schema":{"type":"object","oneOf":[{"$ref":"#/components/schemas/OneTrustResponseOfVendorInventory"},{"$ref":"#/components/schemas/OneTrustResponseOfAssetInventory"},{"$ref":"#/components/schemas/OneTrustResponseOfEntityInventory"},{"$ref":"#/components/schemas/OneTrustResponseOfInventory"}]},"examples":{"vendors":{"summary":"Vendor Inventory Response","description":"vendors","value":{"data":{"id":"9a7c3ec1-7830-4811-8563-36e0a093e7ae","name":"Vendor Name","organization":{"value":"aws","id":"01d5d6db-a3f0-424e-9956-cfa205dc8af7"},"type":{"value":"Operations","id":"a9e976c7-f643-4e3c-94c6-edec5d0279a9","valueKey":"VendorsTypeOperations"},"isEditable":true,"isDeletable":true,"canViewDetails":true,"status":{"key":"active"},"number":1,"isParent":false,"updatedBy":{"id":"ab0b11d9-8ba2-46f3-b845-2ca50bef4efc"},"createdBy":{"id":"ab0b11d9-8ba2-46f3-b845-2ca50bef4efc"},"createdDate":"2023-05-29T12:06:35.787Z","updatedDate":"2023-06-02T06:29:44.717Z","owner":[{"id":"dc60cf7c-d5f9-4a91-a0ef-2e23faea1d88"}]}}},"assets":{"summary":"Asset Inventory Response","description":"assets","value":{"data":{"id":"9a7c3ec1-7830-4811-8563-36e0a093e7ae","name":"Asset Name","organization":{"value":"aws","id":"01d5d6db-a3f0-424e-9956-cfa205dc8af7"},"location":{"value":"US East","id":"b2c4d6e8-1234-5678-9abc-def012345678"},"isEditable":true,"isDeletable":true,"canViewDetails":true,"status":{"key":"active"},"number":2,"isParent":false,"updatedBy":{"id":"ab0b11d9-8ba2-46f3-b845-2ca50bef4efc"},"createdBy":{"id":"ab0b11d9-8ba2-46f3-b845-2ca50bef4efc"},"createdDate":"2023-05-29T12:06:35.787Z","updatedDate":"2023-06-02T06:29:44.717Z","owner":[{"id":"dc60cf7c-d5f9-4a91-a0ef-2e23faea1d88"}]}}},"processing-activities":{"summary":"Processing Activity Inventory Response","description":"processing-activities","value":{"data":{"id":"9a7c3ec1-7830-4811-8563-36e0a093e7ae","name":"Processing Activity Name","organization":{"value":"aws","id":"01d5d6db-a3f0-424e-9956-cfa205dc8af7"},"isEditable":true,"isDeletable":true,"canViewDetails":true,"status":{"key":"active"},"number":3,"isParent":false,"updatedBy":{"id":"ab0b11d9-8ba2-46f3-b845-2ca50bef4efc"},"createdBy":{"id":"ab0b11d9-8ba2-46f3-b845-2ca50bef4efc"},"createdDate":"2023-05-29T12:06:35.787Z","updatedDate":"2023-06-02T06:29:44.717Z","owner":[{"id":"dc60cf7c-d5f9-4a91-a0ef-2e23faea1d88"}]}}},"entities":{"summary":"Entity Inventory Response","description":"entities","value":{"data":{"id":"9a7c3ec1-7830-4811-8563-36e0a093e7ae","name":"Entity Name","organization":{"value":"aws","id":"01d5d6db-a3f0-424e-9956-cfa205dc8af7"},"primaryOperatingLocation":{"value":"US East","id":"b2c4d6e8-1234-5678-9abc-def012345678"},"isEditable":true,"isDeletable":true,"canViewDetails":true,"status":{"key":"active"},"number":4,"isParent":false,"updatedBy":{"id":"ab0b11d9-8ba2-46f3-b845-2ca50bef4efc"},"createdBy":{"id":"ab0b11d9-8ba2-46f3-b845-2ca50bef4efc"},"createdDate":"2023-05-29T12:06:35.787Z","updatedDate":"2023-06-02T06:29:44.717Z","owner":[{"id":"dc60cf7c-d5f9-4a91-a0ef-2e23faea1d88"}]}}}}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.uleth.idm.oclc.org/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/v2/inventories/{schemaName}/{id}":{"get":{"operationId":"getInventoryByIdUsingGET","summary":"Get Inventory by ID","description":"Use this API to retrieve the details of a specific inventory.","tags":["Inventory"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.uleth.idm.oclc.org/onetrust/openapi/privacy-automation-data-mapping-automation.json"},"parameters":[{"name":"schemaName","in":"path","description":"The `name` property of the schema. The value can be obtained using the [Get Schemas](/onetrust/reference/getSchemas) API.","required":true,"schema":{"type":"string","enum":["processing-activities","vendors","assets","entities"]},"example":"vendors"},{"name":"id","in":"path","description":"The unique identifier of an inventory record. The value can be obtained using the [List Inventories](/onetrust/reference/getInventoryList) API.","required":true,"schema":{"type":"string","format":"uuid"},"example":"9a7c3ec1-7830-4811-8563-36e0a093e7ae"}],"responses":{"200":{"description":"OK - Successfully retrieved inventory details.","content":{"application/json":{"schema":{"type":"object","oneOf":[{"$ref":"#/components/schemas/OneTrustResponseOfVendorInventory"},{"$ref":"#/components/schemas/OneTrustResponseOfAssetInventory"},{"$ref":"#/components/schemas/OneTrustResponseOfEntityInventory"},{"$ref":"#/components/schemas/OneTrustResponseOfInventory"}]},"examples":{"vendors":{"summary":"Vendor Inventory Response","description":"vendors","value":{"data":{"id":"9a7c3ec1-7830-4811-8563-36e0a093e7ae","name":"Vendor Name","organization":{"value":"aws","id":"01d5d6db-a3f0-424e-9956-cfa205dc8af7"},"type":{"value":"Operations","id":"a9e976c7-f643-4e3c-94c6-edec5d0279a9","valueKey":"VendorsTypeOperations"},"isEditable":true,"isDeletable":true,"canViewDetails":true,"status":{"key":"active"},"number":1,"isParent":false,"updatedBy":{"id":"ab0b11d9-8ba2-46f3-b845-2ca50bef4efc"},"createdBy":{"id":"ab0b11d9-8ba2-46f3-b845-2ca50bef4efc"},"createdDate":"2023-05-29T12:06:35.787Z","updatedDate":"2023-06-02T06:29:44.717Z","owner":[{"id":"dc60cf7c-d5f9-4a91-a0ef-2e23faea1d88"}]}}},"assets":{"summary":"Asset Inventory Response","description":"assets","value":{"data":{"id":"9a7c3ec1-7830-4811-8563-36e0a093e7ae","name":"Asset Name","organization":{"value":"aws","id":"01d5d6db-a3f0-424e-9956-cfa205dc8af7"},"location":{"value":"US East","id":"b2c4d6e8-1234-5678-9abc-def012345678"},"isEditable":true,"isDeletable":true,"canViewDetails":true,"status":{"key":"active"},"number":2,"isParent":false,"updatedBy":{"id":"ab0b11d9-8ba2-46f3-b845-2ca50bef4efc"},"createdBy":{"id":"ab0b11d9-8ba2-46f3-b845-2ca50bef4efc"},"createdDate":"2023-05-29T12:06:35.787Z","updatedDate":"2023-06-02T06:29:44.717Z","owner":[{"id":"dc60cf7c-d5f9-4a91-a0ef-2e23faea1d88"}]}}},"processing-activities":{"summary":"Processing Activity Inventory Response","description":"processing-activities","value":{"data":{"id":"9a7c3ec1-7830-4811-8563-36e0a093e7ae","name":"Processing Activity Name","organization":{"value":"aws","id":"01d5d6db-a3f0-424e-9956-cfa205dc8af7"},"isEditable":true,"isDeletable":true,"canViewDetails":true,"status":{"key":"active"},"number":3,"isParent":false,"updatedBy":{"id":"ab0b11d9-8ba2-46f3-b845-2ca50bef4efc"},"createdBy":{"id":"ab0b11d9-8ba2-46f3-b845-2ca50bef4efc"},"createdDate":"2023-05-29T12:06:35.787Z","updatedDate":"2023-06-02T06:29:44.717Z","owner":[{"id":"dc60cf7c-d5f9-4a91-a0ef-2e23faea1d88"}]}}},"entities":{"summary":"Entity Inventory Response","description":"entities","value":{"data":{"id":"9a7c3ec1-7830-4811-8563-36e0a093e7ae","name":"Entity Name","organization":{"value":"aws","id":"01d5d6db-a3f0-424e-9956-cfa205dc8af7"},"primaryOperatingLocation":{"value":"US East","id":"b2c4d6e8-1234-5678-9abc-def012345678"},"isEditable":true,"isDeletable":true,"canViewDetails":true,"status":{"key":"active"},"number":4,"isParent":false,"updatedBy":{"id":"ab0b11d9-8ba2-46f3-b845-2ca50bef4efc"},"createdBy":{"id":"ab0b11d9-8ba2-46f3-b845-2ca50bef4efc"},"createdDate":"2023-05-29T12:06:35.787Z","updatedDate":"2023-06-02T06:29:44.717Z","owner":[{"id":"dc60cf7c-d5f9-4a91-a0ef-2e23faea1d88"}]}}}}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.uleth.idm.oclc.org/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"]}]},"put":{"operationId":"updateInventoryUsingPUT","summary":"Update Inventory by ID","description":"Use this API to update the existing inventory. The body of the update request should contain a single object with fields in the same format as the output of the inventory detail endpoint. Only include the fields that need to be updated.","tags":["Inventory"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.uleth.idm.oclc.org/onetrust/openapi/privacy-automation-data-mapping-automation.json"},"parameters":[{"name":"schemaName","in":"path","description":"The `name` property of the schema.","required":true,"schema":{"type":"string","enum":["processing-activities","vendors","assets","entities"]},"example":"vendors"},{"name":"id","in":"path","description":"The unique identifier of an inventory record.","required":true,"schema":{"type":"string","format":"uuid"},"example":"c79fb1a9-9406-4e9b-bff7-c72e635ee82b"},{"name":"primaryEntity","in":"query","description":"Flag to indicate if this is a primary entity update.","required":false,"schema":{"type":"boolean","default":false},"example":false}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateInventoryRequest"},"example":{"inventoryIds":["c79fb1a9-9406-4e9b-bff7-c72e635ee82b"],"inventoryRequest":{"name":"New Vendor","status":"active"}}}}},"responses":{"200":{"description":"OK - Inventory successfully updated.","content":{"application/json":{"schema":{"type":"object","oneOf":[{"$ref":"#/components/schemas/OneTrustResponseOfVendorInventory"},{"$ref":"#/components/schemas/OneTrustResponseOfAssetInventory"},{"$ref":"#/components/schemas/OneTrustResponseOfEntityInventory"},{"$ref":"#/components/schemas/OneTrustResponseOfInventory"}]},"examples":{"vendors":{"summary":"Vendor Inventory Response","description":"vendors","value":{"data":{"id":"9a7c3ec1-7830-4811-8563-36e0a093e7ae","name":"Vendor Name","organization":{"value":"aws","id":"01d5d6db-a3f0-424e-9956-cfa205dc8af7"},"type":{"value":"Operations","id":"a9e976c7-f643-4e3c-94c6-edec5d0279a9","valueKey":"VendorsTypeOperations"},"isEditable":true,"isDeletable":true,"canViewDetails":true,"status":{"key":"active"},"number":1,"isParent":false,"updatedBy":{"id":"ab0b11d9-8ba2-46f3-b845-2ca50bef4efc"},"createdBy":{"id":"ab0b11d9-8ba2-46f3-b845-2ca50bef4efc"},"createdDate":"2023-05-29T12:06:35.787Z","updatedDate":"2023-06-02T06:29:44.717Z","owner":[{"id":"dc60cf7c-d5f9-4a91-a0ef-2e23faea1d88"}]}}},"assets":{"summary":"Asset Inventory Response","description":"assets","value":{"data":{"id":"9a7c3ec1-7830-4811-8563-36e0a093e7ae","name":"Asset Name","organization":{"value":"aws","id":"01d5d6db-a3f0-424e-9956-cfa205dc8af7"},"location":{"value":"US East","id":"b2c4d6e8-1234-5678-9abc-def012345678"},"isEditable":true,"isDeletable":true,"canViewDetails":true,"status":{"key":"active"},"number":2,"isParent":false,"updatedBy":{"id":"ab0b11d9-8ba2-46f3-b845-2ca50bef4efc"},"createdBy":{"id":"ab0b11d9-8ba2-46f3-b845-2ca50bef4efc"},"createdDate":"2023-05-29T12:06:35.787Z","updatedDate":"2023-06-02T06:29:44.717Z","owner":[{"id":"dc60cf7c-d5f9-4a91-a0ef-2e23faea1d88"}]}}},"processing-activities":{"summary":"Processing Activity Inventory Response","description":"processing-activities","value":{"data":{"id":"9a7c3ec1-7830-4811-8563-36e0a093e7ae","name":"Processing Activity Name","organization":{"value":"aws","id":"01d5d6db-a3f0-424e-9956-cfa205dc8af7"},"isEditable":true,"isDeletable":true,"canViewDetails":true,"status":{"key":"active"},"number":3,"isParent":false,"updatedBy":{"id":"ab0b11d9-8ba2-46f3-b845-2ca50bef4efc"},"createdBy":{"id":"ab0b11d9-8ba2-46f3-b845-2ca50bef4efc"},"createdDate":"2023-05-29T12:06:35.787Z","updatedDate":"2023-06-02T06:29:44.717Z","owner":[{"id":"dc60cf7c-d5f9-4a91-a0ef-2e23faea1d88"}]}}},"entities":{"summary":"Entity Inventory Response","description":"entities","value":{"data":{"id":"9a7c3ec1-7830-4811-8563-36e0a093e7ae","name":"Entity Name","organization":{"value":"aws","id":"01d5d6db-a3f0-424e-9956-cfa205dc8af7"},"primaryOperatingLocation":{"value":"US East","id":"b2c4d6e8-1234-5678-9abc-def012345678"},"isEditable":true,"isDeletable":true,"canViewDetails":true,"status":{"key":"active"},"number":4,"isParent":false,"updatedBy":{"id":"ab0b11d9-8ba2-46f3-b845-2ca50bef4efc"},"createdBy":{"id":"ab0b11d9-8ba2-46f3-b845-2ca50bef4efc"},"createdDate":"2023-05-29T12:06:35.787Z","updatedDate":"2023-06-02T06:29:44.717Z","owner":[{"id":"dc60cf7c-d5f9-4a91-a0ef-2e23faea1d88"}]}}}}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.uleth.idm.oclc.org/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"]}]},"delete":{"operationId":"deleteInventoryUsingDELETE","summary":"Delete Inventory","description":"Use this API to delete an Inventory record.","tags":["Inventory"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.uleth.idm.oclc.org/onetrust/openapi/privacy-automation-data-mapping-automation.json"},"parameters":[{"name":"schemaName","in":"path","description":"The `name` property of the schema.","required":true,"schema":{"type":"string","enum":["processing-activities","vendors","assets","entities"]},"example":"vendors"},{"name":"id","in":"path","description":"The unique identifier of an inventory record.","required":true,"schema":{"type":"string","format":"uuid"},"example":"c79fb1a9-9406-4e9b-bff7-c72e635ee82b"},{"name":"deleteType","in":"query","description":"The type of deletion to perform. SOFT marks the record as deleted but retains it, HARD permanently deletes it.","required":false,"schema":{"type":"string","default":"SOFT","enum":["SOFT","HARD"]},"example":"SOFT"},{"name":"deleteReason","in":"query","description":"An optional message for auditing indicating why the record was deleted.","required":false,"schema":{"type":"string","default":"Deleted via API Workflow"},"example":"No longer needed"}],"responses":{"200":{"description":"OK - Inventory successfully deleted."},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.uleth.idm.oclc.org/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"]}]}},"/api/inventory/v2/inventories/{schemaName}/{id}/copy":{"post":{"operationId":"copyInventoryUsingPOST","summary":"Copy Inventory","description":"Use this API to create a copy of an existing inventory.","tags":["Inventory"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.uleth.idm.oclc.org/onetrust/openapi/privacy-automation-data-mapping-automation.json"},"parameters":[{"name":"schemaName","in":"path","description":"The `name` property of the schema.","required":true,"schema":{"type":"string","enum":["processing-activities","vendors","assets","entities"]},"example":"vendors"},{"name":"id","in":"path","description":"The unique identifier of the inventory record to copy.","required":true,"schema":{"type":"string","format":"uuid"},"example":"c79fb1a9-9406-4e9b-bff7-c72e635ee82b"},{"name":"inheritFromMaster","in":"query","description":"Flag to indicate if the copy should inherit attributes from the master inventory.","required":false,"schema":{"type":"boolean","default":true},"example":true},{"name":"copyRelated","in":"query","description":"Flag to indicate if related records should also be copied.","required":false,"schema":{"type":"boolean","default":false},"example":false},{"name":"copyAsChild","in":"query","description":"Flag to indicate if the copy should be created as a child of the original inventory.","required":false,"schema":{"type":"boolean","default":false},"example":false}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory"},"example":{"name":"Copied Vendor","status":{"key":"active"},"description":"Copy of vendor"}}}},"responses":{"200":{"description":"OK - Inventory successfully copied."},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.uleth.idm.oclc.org/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","COPY_INVENTORY"]}]}},"/api/inventory/v2/inventories/{schemaName}/{id}/status":{"put":{"operationId":"updateInventoryStatusByIdUsingPUT","summary":"Update Inventory Status","description":"Use this API to change the existing status of an inventory.","tags":["Inventory"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.uleth.idm.oclc.org/onetrust/openapi/privacy-automation-data-mapping-automation.json"},"parameters":[{"name":"schemaName","in":"path","description":"The `name` property of the schema.","required":true,"schema":{"type":"string","enum":["processing-activities","vendors","assets","entities"]},"example":"vendors"},{"name":"id","in":"path","description":"The unique identifier of an inventory record.","required":true,"schema":{"type":"string","format":"uuid"},"example":"c79fb1a9-9406-4e9b-bff7-c72e635ee82b"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyNameDto"}}}},"responses":{"200":{"description":"OK - Inventory status successfully updated."},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.uleth.idm.oclc.org/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","DATA_MAPPING_INVENTORY_CHANGE_STATUS"]}]}},"/api/inventory/v2/inventories/{type}/{inventoryId}/control-implementations":{"post":{"operationId":"addControlsToInventoryUsingPOST","summary":"Create Control Implementation","description":"Use this API to create one or more control implementations on an inventory using the `type` and `id` for the inventory item and the id(s) of the master controls. When the operation is run unsuccessfully, this will return an exception.","tags":["Inventory Relationships V1"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.uleth.idm.oclc.org/onetrust/openapi/privacy-automation-data-mapping-automation.json"},"parameters":[{"name":"type","in":"path","description":"The type of inventory to add controls to","required":true,"schema":{"type":"string","enum":["processing-activities","vendors","assets","entities"]}},{"name":"inventoryId","in":"path","description":"The unique identifier of an inventory record. This value can be obtained using the [Get List of Inventories](/onetrust/reference/getinventorylist) API.","required":true,"schema":{"type":"string","format":"uuid"},"example":"1c3fa261-36d1-405b-a6cd-5bc734033715"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InventoryControlImplementationsRequest"}}}},"responses":{"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.uleth.idm.oclc.org/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"]}]}},"/api/inventory/v2/inventories-personal-data/{personalDataAssociationId}":{"put":{"operationId":"updateAdvancedAttributesForPersonalDataAssociationUsingPUT","summary":"Update Advanced Attributes for Personal Data Association","description":"Use this API to update the advanced attributes of a Personal Data Association that is linked to an inventory object.","tags":["Inventory Relationships V1"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.uleth.idm.oclc.org/onetrust/openapi/privacy-automation-data-mapping-automation.json"},"parameters":[{"name":"inventoryType","in":"query","description":"Type of the inventory","required":true,"schema":{"type":"string","enum":["processing-activities","vendors","assets","entities"]},"example":"assets"},{"name":"personalDataAssociationId","in":"path","description":"ID of the personal data association","required":true,"schema":{"type":"string","format":"uuid"},"example":"4374d5da-44ac-4308-a298-3efdb0f34ba4"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalDataLinkAttributesRequest"}}}},"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.uleth.idm.oclc.org/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/v2/inventory-hierarchies/{rootInventoryId}":{"get":{"operationId":"getHierarchyForInventoryIdUsingGET","summary":"Get List of Child Inventories by Root Inventory","description":"Use this API to provide a paginated list of Child Inventories for a given Inventory Schema Type and a Root Inventory Id.","tags":["Inventory Hierarchies"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.uleth.idm.oclc.org/onetrust/openapi/privacy-automation-data-mapping-automation.json"},"parameters":[{"name":"rootInventoryId","in":"path","description":"The unique identifier of the root inventory","required":true,"schema":{"type":"string","format":"uuid"},"example":"96214230-ffbb-4870-b6c4-0f30c3bfec60"},{"name":"inventoryType","in":"query","description":"The type of inventory (e.g., assets, vendors, processing-activities, legal-entities)","required":true,"schema":{"type":"string","enum":["processing-activities","vendors","assets","entities"]},"example":"assets"},{"name":"page","in":"query","description":"Results page to be retrieved (0..N)","schema":{"type":"integer","format":"int32","default":0,"minimum":0},"example":0},{"name":"size","in":"query","description":"Number of records per page (1..50)","schema":{"type":"integer","format":"int32","default":20,"maximum":50,"minimum":1},"example":20},{"name":"sort","in":"query","description":"Sorting criteria in the format: property(,asc|desc). Default sort order is ascending","schema":{"type":"string","enum":["name,asc","name,desc","createdDate,asc","createdDate,desc"]},"example":"name,asc"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.uleth.idm.oclc.org/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":"unlinkChildInventoryFromHierarchyUsingDELETE","summary":"Remove Child Inventory from Root Inventory","description":"Use this API to unlink a Child Inventory from a Root Inventory.","tags":["Inventory Hierarchies"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.uleth.idm.oclc.org/onetrust/openapi/privacy-automation-data-mapping-automation.json"},"parameters":[{"name":"rootInventoryId","in":"path","description":"The unique identifier of the root inventory","required":true,"schema":{"type":"string","format":"uuid"},"example":"96214230-ffbb-4870-b6c4-0f30c3bfec60"},{"name":"inventoryType","in":"query","description":"The type of inventory (e.g., assets, vendors, processing-activities, legal-entities)","required":true,"schema":{"type":"string","enum":["processing-activities","vendors","assets","entities"]},"example":"assets"},{"name":"childInventoryId","in":"query","description":"The unique identifier of the child inventory to unlink","required":true,"schema":{"type":"string","format":"uuid"},"example":"6ed251ca-969a-486f-a645-e5fc3c709f55"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.uleth.idm.oclc.org/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/v2/schemas":{"get":{"operationId":"getAllSchemasUsingGET","summary":"Get List of Inventory Schemas","description":"Use this API to retrieve the list of schemas.","tags":["Inventory Schema"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.uleth.idm.oclc.org/onetrust/openapi/privacy-automation-data-mapping-automation.json"},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SchemaSummaryDto"}},"example":[{"id":"data-elements","name":"DataElements","description":"DataElementsInventory","nameKey":"DataElements","uri":"/api/inventory/v2/data-elements"},{"id":"processing-activities","name":"ProcessingActivities","description":"ProcessingActivitiesInventory","nameKey":"ProcessingActivities","uri":"/api/inventory/v2/inventories/processing-activities"},{"id":"assets","name":"Assets","description":"AssetsInventory","nameKey":"Assets","uri":"/api/inventory/v2/inventories/assets"},{"id":"vendors","name":"Vendors","description":"VendorInventory","nameKey":"Vendors","uri":"/api/inventory/v2/inventories/vendors"},{"id":"entities","name":"Entities","description":"LegalEntitiesInventory","nameKey":"Entities","uri":"/api/inventory/v2/inventories/entities"}]}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.uleth.idm.oclc.org/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/v2/schemas/{schemaName}/attributes/{fieldName}":{"get":{"operationId":"getSchemaDetailsUsingFieldName","summary":"Get Inventory Schema Details","description":"Use this API to retrieve the schema details by field name.","tags":["Inventory Schema"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.uleth.idm.oclc.org/onetrust/openapi/privacy-automation-data-mapping-automation.json"},"parameters":[{"name":"schemaName","in":"path","description":"Type of the inventory or schema. The supporting types are 'processing-activities', 'vendors', 'assets', and 'entities'.","required":true,"schema":{"type":"string","enum":["processing-activities","vendors","assets","entities"]},"example":"vendors"},{"name":"fieldName","in":"path","description":"Field name of the attribute to retrieve details for","required":true,"schema":{"type":"string"},"example":"name"},{"name":"showAll","in":"query","description":"Flag to show all attribute values including inactive ones","required":false,"schema":{"type":"boolean","enum":["true","false"]},"example":true},{"name":"optionsSize","in":"query","required":false,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttributeDetailResponse"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.uleth.idm.oclc.org/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"]}]}}},"components":{"schemas":{"JsonNode":{"type":"object"},"UpdateInventoryRequest":{"type":"object","properties":{"inventoryIds":{"description":"List of inventory record UUIDs to be updated.","type":"array","items":{"type":"string","format":"uuid"},"example":["c79fb1a9-9406-4e9b-bff7-c72e635ee82b"],"minItems":1},"inventoryRequest":{"description":"The inventory update payload as a JSON object.","example":{"name":"New Vendor","status":"active"},"$ref":"#/components/schemas/JsonNode"}},"example":{"inventoryIds":["c79fb1a9-9406-4e9b-bff7-c72e635ee82b"],"inventoryRequest":{"name":"New Vendor","status":"active"}}},"InventoryValue":{"type":"object","properties":{"id":{"description":"Unique identifier of the inventory value","type":"string","format":"uuid","example":"7e9d5f2a-8b1c-4d3e-9f6a-1a2b3c4d5e6f"},"value":{"description":"The display value","type":"string","example":"High Risk"},"valueKey":{"description":"The key of the value","type":"string","example":"HIGH_RISK"},"colorCode":{"description":"Color code associated with the value","type":"string","example":"#FF0000"},"selectionValue":{"description":"Selection value","type":"string","example":"high"}}},"InventoryWorkflowStageDto":{"type":"object","properties":{"stage":{"description":"Reference to the workflow stage","$ref":"#/components/schemas/ObjectReference"},"badgeColor":{"description":"Color code for the workflow stage badge","type":"string","example":"#4CAF50"}}},"KeyNameDto":{"type":"object","properties":{"key":{"description":"The key identifier","type":"string","example":"active"},"name":{"description":"The display name associated with the key","type":"string","example":"Active"}},"required":["key"]},"ObjectReference":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"value":{"type":"string"},"valueKey":{"type":"string"}}},"OneTrustResponseOfVendorInventory":{"type":"object","properties":{"data":{"description":"Inventory details","$ref":"#/components/schemas/VendorInventory"}}},"SimilarRecordDetail":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"organization":{"$ref":"#/components/schemas/ObjectReference"},"location":{"$ref":"#/components/schemas/ObjectReference"},"hasAccessToSimilarRecord":{"type":"boolean"}}},"VendorInventory":{"type":"object","properties":{"id":{"description":"Unique identifier of the inventory item","type":"string","format":"uuid","example":"96214230-ffbb-4870-b6c4-0f30c3bfec60"},"organization":{"description":"Organization reference to which the inventory belongs","$ref":"#/components/schemas/ObjectReference"},"canViewDetails":{"description":"Flag indicating if the current user can view inventory details","type":"boolean","example":true},"name":{"description":"Name of the inventory","type":"string","example":"Vendor XYZ"},"riskLevel":{"description":"Risk level of the inventory","type":"string","example":"HIGH","enum":["ZERO","LOW","MEDIUM","HIGH","VERY_HIGH"]},"riskScore":{"description":"Risk score of the inventory","type":"number","example":8.5},"status":{"description":"Status of the inventory","example":{"key":"active","name":"Active"},"$ref":"#/components/schemas/KeyNameDto"},"externalId":{"description":"External identifier of the inventory","type":"string","example":"EXT-12345"},"createdDate":{"description":"Date and time when the inventory was created","type":"string","format":"date-time","example":"2023-01-15T10:30:45.123Z"},"createdBy":{"description":"Reference to the user who created the inventory","example":{"id":"ab0b11d9-8ba2-46f3-b845-2ca50bef4efc","value":null},"$ref":"#/components/schemas/ObjectReference"},"updatedDate":{"description":"Date and time when the inventory was last updated","type":"string","format":"date-time","example":"2023-02-20T14:15:30.456Z"},"updatedBy":{"description":"Reference to the user who last updated the inventory","example":{"id":"ab0b11d9-8ba2-46f3-b845-2ca50bef4efc","value":null},"$ref":"#/components/schemas/ObjectReference"},"selectFields":{"description":"Map of select fields with their values","type":"object","example":{"data-residency":[{"key":"us","value":"US"}]},"additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/InventoryValue"}}},"textFields":{"description":"Map of text fields with their values","type":"object","example":{"description":"Sample description"},"additionalProperties":{"type":"string"}},"number":{"description":"Sequence number of the inventory","type":"integer","format":"int64","example":123},"isParent":{"description":"Flag indicating if this inventory is a parent","type":"boolean","example":true},"inheritFromMaster":{"description":"Flag indicating if this inventory inherits from master","type":"boolean","example":true},"parentInventoryId":{"description":"ID of the parent inventory","type":"string","format":"uuid","example":"96214230-ffbb-4870-b6c4-0f30c3bfec60"},"masterRecord":{"description":"Reference to the master record","type":"string","example":"MASTER-001"},"workflow":{"description":"Reference to the workflow associated with this inventory","example":{"id":"0cfe2b89-1d73-4c07-8c6b-ff1a5a6c8b88","value":"Vendor Review Workflow"},"$ref":"#/components/schemas/ObjectReference"},"workflowStage":{"description":"Current workflow stage of the inventory","example":{"stage":{"id":"c2c9a3b4-1d20-4bd4-8b86-5a6ef5a3b2a1","value":"In Review"},"badgeColor":"#4CAF50"},"$ref":"#/components/schemas/InventoryWorkflowStageDto"},"inherentRiskLevel":{"description":"Inherent risk level of the inventory","type":"string","example":"MEDIUM","enum":["ZERO","LOW","MEDIUM","HIGH","VERY_HIGH"]},"inherentRiskScore":{"description":"Inherent risk score of the inventory","type":"number","example":6.5},"targetRiskLevel":{"description":"Target risk level of the inventory","type":"string","example":"LOW","enum":["ZERO","LOW","MEDIUM","HIGH","VERY_HIGH"]},"targetRiskScore":{"description":"Target risk score of the inventory","type":"number","example":3},"totalHierarchyRiskLevel":{"description":"Total hierarchy risk level of the inventory","type":"string","example":"HIGH","enum":["ZERO","LOW","MEDIUM","HIGH","VERY_HIGH"]},"totalHierarchyRiskScore":{"description":"Total hierarchy risk score of the inventory","type":"number","example":8},"totalHierarchyInherentRiskLevel":{"description":"Total hierarchy inherent risk level of the inventory","type":"string","example":"MEDIUM","enum":["ZERO","LOW","MEDIUM","HIGH","VERY_HIGH"]},"totalHierarchyInherentRiskScore":{"description":"Total hierarchy inherent risk score of the inventory","type":"number","example":6},"totalHierarchyTargetRiskLevel":{"description":"Total hierarchy target risk level of the inventory","type":"string","example":"LOW","enum":["ZERO","LOW","MEDIUM","HIGH","VERY_HIGH"]},"totalHierarchyTargetRiskScore":{"description":"Total hierarchy target risk score of the inventory","type":"number","example":3},"inventoryDeleteType":{"description":"Type of deletion for the inventory","type":"string","example":"SOFT","enum":["HARD","SOFT","NONE"]},"deletedReason":{"description":"Reason for deletion of the inventory","type":"string","example":"No longer required"},"deletedBy":{"description":"ID of the user who deleted the inventory","type":"string","format":"uuid","example":"ab0b11d9-8ba2-46f3-b845-2ca50bef4efc"},"deletedDate":{"description":"Date and time when the inventory was deleted","type":"string","format":"date-time","example":"2023-03-01T12:00:00.000Z"},"isGlobalAttributeConfigurationEnabled":{"description":"Flag indicating if global attribute configuration is enabled","type":"boolean","example":true},"sourceId":{"description":"ID of the source inventory","type":"string","format":"uuid","example":"c79fb1a9-9406-4e9b-bff7-c72e635ee82b"},"integrationWorkflowId":{"description":"ID of the integration workflow","type":"string","example":"wf-123"},"sourceType":{"description":"Type of the source inventory","type":"string","example":"API_INTEGRATION"},"reviewType":{"description":"Type of review for the inventory","type":"string","example":"ANNUAL"},"similarRecord":{"description":"Similar record detail for the inventory","example":{"id":"c79fb1a9-9406-4e9b-bff7-c72e635ee82b","name":"Vendor ABC","hasAccessToSimilarRecord":true},"$ref":"#/components/schemas/SimilarRecordDetail"},"type":{"description":"Type reference","example":{"id":"cc11c8a5-bbb3-4377-a33d-52a23b1455f9","value":"Regulatory"},"$ref":"#/components/schemas/ObjectReference"},"deletable":{"type":"boolean"},"editable":{"type":"boolean"}}},"AssetInventory":{"type":"object","properties":{"id":{"description":"Unique identifier of the inventory item","type":"string","format":"uuid","example":"96214230-ffbb-4870-b6c4-0f30c3bfec60"},"organization":{"description":"Organization reference to which the inventory belongs","$ref":"#/components/schemas/ObjectReference"},"canViewDetails":{"description":"Flag indicating if the current user can view inventory details","type":"boolean","example":true},"name":{"description":"Name of the inventory","type":"string","example":"Vendor XYZ"},"riskLevel":{"description":"Risk level of the inventory","type":"string","example":"HIGH","enum":["ZERO","LOW","MEDIUM","HIGH","VERY_HIGH"]},"riskScore":{"description":"Risk score of the inventory","type":"number","example":8.5},"status":{"description":"Status of the inventory","example":{"key":"active","name":"Active"},"$ref":"#/components/schemas/KeyNameDto"},"externalId":{"description":"External identifier of the inventory","type":"string","example":"EXT-12345"},"createdDate":{"description":"Date and time when the inventory was created","type":"string","format":"date-time","example":"2023-01-15T10:30:45.123Z"},"createdBy":{"description":"Reference to the user who created the inventory","example":{"id":"ab0b11d9-8ba2-46f3-b845-2ca50bef4efc","value":null},"$ref":"#/components/schemas/ObjectReference"},"updatedDate":{"description":"Date and time when the inventory was last updated","type":"string","format":"date-time","example":"2023-02-20T14:15:30.456Z"},"updatedBy":{"description":"Reference to the user who last updated the inventory","example":{"id":"ab0b11d9-8ba2-46f3-b845-2ca50bef4efc","value":null},"$ref":"#/components/schemas/ObjectReference"},"selectFields":{"description":"Map of select fields with their values","type":"object","example":{"data-residency":[{"key":"us","value":"US"}]},"additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/InventoryValue"}}},"textFields":{"description":"Map of text fields with their values","type":"object","example":{"description":"Sample description"},"additionalProperties":{"type":"string"}},"number":{"description":"Sequence number of the inventory","type":"integer","format":"int64","example":123},"isParent":{"description":"Flag indicating if this inventory is a parent","type":"boolean","example":true},"inheritFromMaster":{"description":"Flag indicating if this inventory inherits from master","type":"boolean","example":true},"parentInventoryId":{"description":"ID of the parent inventory","type":"string","format":"uuid","example":"96214230-ffbb-4870-b6c4-0f30c3bfec60"},"masterRecord":{"description":"Reference to the master record","type":"string","example":"MASTER-001"},"workflow":{"description":"Reference to the workflow associated with this inventory","example":{"id":"0cfe2b89-1d73-4c07-8c6b-ff1a5a6c8b88","value":"Vendor Review Workflow"},"$ref":"#/components/schemas/ObjectReference"},"workflowStage":{"description":"Current workflow stage of the inventory","example":{"stage":{"id":"c2c9a3b4-1d20-4bd4-8b86-5a6ef5a3b2a1","value":"In Review"},"badgeColor":"#4CAF50"},"$ref":"#/components/schemas/InventoryWorkflowStageDto"},"inherentRiskLevel":{"description":"Inherent risk level of the inventory","type":"string","example":"MEDIUM","enum":["ZERO","LOW","MEDIUM","HIGH","VERY_HIGH"]},"inherentRiskScore":{"description":"Inherent risk score of the inventory","type":"number","example":6.5},"targetRiskLevel":{"description":"Target risk level of the inventory","type":"string","example":"LOW","enum":["ZERO","LOW","MEDIUM","HIGH","VERY_HIGH"]},"targetRiskScore":{"description":"Target risk score of the inventory","type":"number","example":3},"totalHierarchyRiskLevel":{"description":"Total hierarchy risk level of the inventory","type":"string","example":"HIGH","enum":["ZERO","LOW","MEDIUM","HIGH","VERY_HIGH"]},"totalHierarchyRiskScore":{"description":"Total hierarchy risk score of the inventory","type":"number","example":8},"totalHierarchyInherentRiskLevel":{"description":"Total hierarchy inherent risk level of the inventory","type":"string","example":"MEDIUM","enum":["ZERO","LOW","MEDIUM","HIGH","VERY_HIGH"]},"totalHierarchyInherentRiskScore":{"description":"Total hierarchy inherent risk score of the inventory","type":"number","example":6},"totalHierarchyTargetRiskLevel":{"description":"Total hierarchy target risk level of the inventory","type":"string","example":"LOW","enum":["ZERO","LOW","MEDIUM","HIGH","VERY_HIGH"]},"totalHierarchyTargetRiskScore":{"description":"Total hierarchy target risk score of the inventory","type":"number","example":3},"inventoryDeleteType":{"description":"Type of deletion for the inventory","type":"string","example":"SOFT","enum":["HARD","SOFT","NONE"]},"deletedReason":{"description":"Reason for deletion of the inventory","type":"string","example":"No longer required"},"deletedBy":{"description":"ID of the user who deleted the inventory","type":"string","format":"uuid","example":"ab0b11d9-8ba2-46f3-b845-2ca50bef4efc"},"deletedDate":{"description":"Date and time when the inventory was deleted","type":"string","format":"date-time","example":"2023-03-01T12:00:00.000Z"},"isGlobalAttributeConfigurationEnabled":{"description":"Flag indicating if global attribute configuration is enabled","type":"boolean","example":true},"sourceId":{"description":"ID of the source inventory","type":"string","format":"uuid","example":"c79fb1a9-9406-4e9b-bff7-c72e635ee82b"},"integrationWorkflowId":{"description":"ID of the integration workflow","type":"string","example":"wf-123"},"sourceType":{"description":"Type of the source inventory","type":"string","example":"API_INTEGRATION"},"reviewType":{"description":"Type of review for the inventory","type":"string","example":"ANNUAL"},"similarRecord":{"description":"Similar record detail for the inventory","example":{"id":"c79fb1a9-9406-4e9b-bff7-c72e635ee82b","name":"Vendor ABC","hasAccessToSimilarRecord":true},"$ref":"#/components/schemas/SimilarRecordDetail"},"location":{"description":"Location reference (required for assets)","example":{"value":"US East","id":"b2c4d6e8-1234-5678-9abc-def012345678"},"$ref":"#/components/schemas/ObjectReference"},"deletable":{"type":"boolean"},"editable":{"type":"boolean"}}},"OneTrustResponseOfAssetInventory":{"type":"object","properties":{"data":{"description":"Inventory details","$ref":"#/components/schemas/AssetInventory"}}},"EntityInventory":{"type":"object","properties":{"id":{"description":"Unique identifier of the inventory item","type":"string","format":"uuid","example":"96214230-ffbb-4870-b6c4-0f30c3bfec60"},"organization":{"description":"Organization reference to which the inventory belongs","$ref":"#/components/schemas/ObjectReference"},"canViewDetails":{"description":"Flag indicating if the current user can view inventory details","type":"boolean","example":true},"name":{"description":"Name of the inventory","type":"string","example":"Vendor XYZ"},"riskLevel":{"description":"Risk level of the inventory","type":"string","example":"HIGH","enum":["ZERO","LOW","MEDIUM","HIGH","VERY_HIGH"]},"riskScore":{"description":"Risk score of the inventory","type":"number","example":8.5},"status":{"description":"Status of the inventory","example":{"key":"active","name":"Active"},"$ref":"#/components/schemas/KeyNameDto"},"externalId":{"description":"External identifier of the inventory","type":"string","example":"EXT-12345"},"createdDate":{"description":"Date and time when the inventory was created","type":"string","format":"date-time","example":"2023-01-15T10:30:45.123Z"},"createdBy":{"description":"Reference to the user who created the inventory","example":{"id":"ab0b11d9-8ba2-46f3-b845-2ca50bef4efc","value":null},"$ref":"#/components/schemas/ObjectReference"},"updatedDate":{"description":"Date and time when the inventory was last updated","type":"string","format":"date-time","example":"2023-02-20T14:15:30.456Z"},"updatedBy":{"description":"Reference to the user who last updated the inventory","example":{"id":"ab0b11d9-8ba2-46f3-b845-2ca50bef4efc","value":null},"$ref":"#/components/schemas/ObjectReference"},"selectFields":{"description":"Map of select fields with their values","type":"object","example":{"data-residency":[{"key":"us","value":"US"}]},"additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/InventoryValue"}}},"textFields":{"description":"Map of text fields with their values","type":"object","example":{"description":"Sample description"},"additionalProperties":{"type":"string"}},"number":{"description":"Sequence number of the inventory","type":"integer","format":"int64","example":123},"isParent":{"description":"Flag indicating if this inventory is a parent","type":"boolean","example":true},"inheritFromMaster":{"description":"Flag indicating if this inventory inherits from master","type":"boolean","example":true},"parentInventoryId":{"description":"ID of the parent inventory","type":"string","format":"uuid","example":"96214230-ffbb-4870-b6c4-0f30c3bfec60"},"masterRecord":{"description":"Reference to the master record","type":"string","example":"MASTER-001"},"workflow":{"description":"Reference to the workflow associated with this inventory","example":{"id":"0cfe2b89-1d73-4c07-8c6b-ff1a5a6c8b88","value":"Vendor Review Workflow"},"$ref":"#/components/schemas/ObjectReference"},"workflowStage":{"description":"Current workflow stage of the inventory","example":{"stage":{"id":"c2c9a3b4-1d20-4bd4-8b86-5a6ef5a3b2a1","value":"In Review"},"badgeColor":"#4CAF50"},"$ref":"#/components/schemas/InventoryWorkflowStageDto"},"inherentRiskLevel":{"description":"Inherent risk level of the inventory","type":"string","example":"MEDIUM","enum":["ZERO","LOW","MEDIUM","HIGH","VERY_HIGH"]},"inherentRiskScore":{"description":"Inherent risk score of the inventory","type":"number","example":6.5},"targetRiskLevel":{"description":"Target risk level of the inventory","type":"string","example":"LOW","enum":["ZERO","LOW","MEDIUM","HIGH","VERY_HIGH"]},"targetRiskScore":{"description":"Target risk score of the inventory","type":"number","example":3},"totalHierarchyRiskLevel":{"description":"Total hierarchy risk level of the inventory","type":"string","example":"HIGH","enum":["ZERO","LOW","MEDIUM","HIGH","VERY_HIGH"]},"totalHierarchyRiskScore":{"description":"Total hierarchy risk score of the inventory","type":"number","example":8},"totalHierarchyInherentRiskLevel":{"description":"Total hierarchy inherent risk level of the inventory","type":"string","example":"MEDIUM","enum":["ZERO","LOW","MEDIUM","HIGH","VERY_HIGH"]},"totalHierarchyInherentRiskScore":{"description":"Total hierarchy inherent risk score of the inventory","type":"number","example":6},"totalHierarchyTargetRiskLevel":{"description":"Total hierarchy target risk level of the inventory","type":"string","example":"LOW","enum":["ZERO","LOW","MEDIUM","HIGH","VERY_HIGH"]},"totalHierarchyTargetRiskScore":{"description":"Total hierarchy target risk score of the inventory","type":"number","example":3},"inventoryDeleteType":{"description":"Type of deletion for the inventory","type":"string","example":"SOFT","enum":["HARD","SOFT","NONE"]},"deletedReason":{"description":"Reason for deletion of the inventory","type":"string","example":"No longer required"},"deletedBy":{"description":"ID of the user who deleted the inventory","type":"string","format":"uuid","example":"ab0b11d9-8ba2-46f3-b845-2ca50bef4efc"},"deletedDate":{"description":"Date and time when the inventory was deleted","type":"string","format":"date-time","example":"2023-03-01T12:00:00.000Z"},"isGlobalAttributeConfigurationEnabled":{"description":"Flag indicating if global attribute configuration is enabled","type":"boolean","example":true},"sourceId":{"description":"ID of the source inventory","type":"string","format":"uuid","example":"c79fb1a9-9406-4e9b-bff7-c72e635ee82b"},"integrationWorkflowId":{"description":"ID of the integration workflow","type":"string","example":"wf-123"},"sourceType":{"description":"Type of the source inventory","type":"string","example":"API_INTEGRATION"},"reviewType":{"description":"Type of review for the inventory","type":"string","example":"ANNUAL"},"similarRecord":{"description":"Similar record detail for the inventory","example":{"id":"c79fb1a9-9406-4e9b-bff7-c72e635ee82b","name":"Vendor ABC","hasAccessToSimilarRecord":true},"$ref":"#/components/schemas/SimilarRecordDetail"},"primaryOperatingLocation":{"description":"Primary operating location reference (required for entities)","example":{"value":"US East","id":"b2c4d6e8-1234-5678-9abc-def012345678"},"$ref":"#/components/schemas/ObjectReference"},"deletable":{"type":"boolean"},"editable":{"type":"boolean"}}},"OneTrustResponseOfEntityInventory":{"type":"object","properties":{"data":{"description":"Inventory details","$ref":"#/components/schemas/EntityInventory"}}},"Inventory":{"type":"object","properties":{"id":{"description":"Unique identifier of the inventory item","type":"string","format":"uuid","example":"96214230-ffbb-4870-b6c4-0f30c3bfec60"},"organization":{"description":"Organization reference to which the inventory belongs","$ref":"#/components/schemas/ObjectReference"},"canViewDetails":{"description":"Flag indicating if the current user can view inventory details","type":"boolean","example":true},"name":{"description":"Name of the inventory","type":"string","example":"Vendor XYZ"},"riskLevel":{"description":"Risk level of the inventory","type":"string","example":"HIGH","enum":["ZERO","LOW","MEDIUM","HIGH","VERY_HIGH"]},"riskScore":{"description":"Risk score of the inventory","type":"number","example":8.5},"status":{"description":"Status of the inventory","example":{"key":"active","name":"Active"},"$ref":"#/components/schemas/KeyNameDto"},"externalId":{"description":"External identifier of the inventory","type":"string","example":"EXT-12345"},"createdDate":{"description":"Date and time when the inventory was created","type":"string","format":"date-time","example":"2023-01-15T10:30:45.123Z"},"createdBy":{"description":"Reference to the user who created the inventory","example":{"id":"ab0b11d9-8ba2-46f3-b845-2ca50bef4efc","value":null},"$ref":"#/components/schemas/ObjectReference"},"updatedDate":{"description":"Date and time when the inventory was last updated","type":"string","format":"date-time","example":"2023-02-20T14:15:30.456Z"},"updatedBy":{"description":"Reference to the user who last updated the inventory","example":{"id":"ab0b11d9-8ba2-46f3-b845-2ca50bef4efc","value":null},"$ref":"#/components/schemas/ObjectReference"},"selectFields":{"description":"Map of select fields with their values","type":"object","example":{"data-residency":[{"key":"us","value":"US"}]},"additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/InventoryValue"}}},"textFields":{"description":"Map of text fields with their values","type":"object","example":{"description":"Sample description"},"additionalProperties":{"type":"string"}},"number":{"description":"Sequence number of the inventory","type":"integer","format":"int64","example":123},"isParent":{"description":"Flag indicating if this inventory is a parent","type":"boolean","example":true},"inheritFromMaster":{"description":"Flag indicating if this inventory inherits from master","type":"boolean","example":true},"parentInventoryId":{"description":"ID of the parent inventory","type":"string","format":"uuid","example":"96214230-ffbb-4870-b6c4-0f30c3bfec60"},"masterRecord":{"description":"Reference to the master record","type":"string","example":"MASTER-001"},"workflow":{"description":"Reference to the workflow associated with this inventory","example":{"id":"0cfe2b89-1d73-4c07-8c6b-ff1a5a6c8b88","value":"Vendor Review Workflow"},"$ref":"#/components/schemas/ObjectReference"},"workflowStage":{"description":"Current workflow stage of the inventory","example":{"stage":{"id":"c2c9a3b4-1d20-4bd4-8b86-5a6ef5a3b2a1","value":"In Review"},"badgeColor":"#4CAF50"},"$ref":"#/components/schemas/InventoryWorkflowStageDto"},"inherentRiskLevel":{"description":"Inherent risk level of the inventory","type":"string","example":"MEDIUM","enum":["ZERO","LOW","MEDIUM","HIGH","VERY_HIGH"]},"inherentRiskScore":{"description":"Inherent risk score of the inventory","type":"number","example":6.5},"targetRiskLevel":{"description":"Target risk level of the inventory","type":"string","example":"LOW","enum":["ZERO","LOW","MEDIUM","HIGH","VERY_HIGH"]},"targetRiskScore":{"description":"Target risk score of the inventory","type":"number","example":3},"totalHierarchyRiskLevel":{"description":"Total hierarchy risk level of the inventory","type":"string","example":"HIGH","enum":["ZERO","LOW","MEDIUM","HIGH","VERY_HIGH"]},"totalHierarchyRiskScore":{"description":"Total hierarchy risk score of the inventory","type":"number","example":8},"totalHierarchyInherentRiskLevel":{"description":"Total hierarchy inherent risk level of the inventory","type":"string","example":"MEDIUM","enum":["ZERO","LOW","MEDIUM","HIGH","VERY_HIGH"]},"totalHierarchyInherentRiskScore":{"description":"Total hierarchy inherent risk score of the inventory","type":"number","example":6},"totalHierarchyTargetRiskLevel":{"description":"Total hierarchy target risk level of the inventory","type":"string","example":"LOW","enum":["ZERO","LOW","MEDIUM","HIGH","VERY_HIGH"]},"totalHierarchyTargetRiskScore":{"description":"Total hierarchy target risk score of the inventory","type":"number","example":3},"inventoryDeleteType":{"description":"Type of deletion for the inventory","type":"string","example":"SOFT","enum":["HARD","SOFT","NONE"]},"deletedReason":{"description":"Reason for deletion of the inventory","type":"string","example":"No longer required"},"deletedBy":{"description":"ID of the user who deleted the inventory","type":"string","format":"uuid","example":"ab0b11d9-8ba2-46f3-b845-2ca50bef4efc"},"deletedDate":{"description":"Date and time when the inventory was deleted","type":"string","format":"date-time","example":"2023-03-01T12:00:00.000Z"},"isGlobalAttributeConfigurationEnabled":{"description":"Flag indicating if global attribute configuration is enabled","type":"boolean","example":true},"sourceId":{"description":"ID of the source inventory","type":"string","format":"uuid","example":"c79fb1a9-9406-4e9b-bff7-c72e635ee82b"},"integrationWorkflowId":{"description":"ID of the integration workflow","type":"string","example":"wf-123"},"sourceType":{"description":"Type of the source inventory","type":"string","example":"API_INTEGRATION"},"reviewType":{"description":"Type of review for the inventory","type":"string","example":"ANNUAL"},"similarRecord":{"description":"Similar record detail for the inventory","example":{"id":"c79fb1a9-9406-4e9b-bff7-c72e635ee82b","name":"Vendor ABC","hasAccessToSimilarRecord":true},"$ref":"#/components/schemas/SimilarRecordDetail"},"deletable":{"type":"boolean"},"editable":{"type":"boolean"}}},"OneTrustResponseOfInventory":{"type":"object","properties":{"data":{"description":"Inventory details","$ref":"#/components/schemas/Inventory"}}},"AssetInventoryCreateRequest":{"type":"object","properties":{"name":{"description":"Name of the inventory","type":"string","example":"Test Asset","minLength":1},"organization":{"description":"Organization reference","example":{"value":"aws","id":"01d5d6db-a3f0-424e-9956-cfa205dc8af7"},"$ref":"#/components/schemas/ObjectReference"},"location":{"description":"Location reference (required for assets)","example":{"value":"US East","id":"b2c4d6e8-1234-5678-9abc-def012345678"},"$ref":"#/components/schemas/ObjectReference"}},"required":["location","name","organization"]},"InventoryTypeReference":{"type":"object","properties":{"id":{"description":"Unique identifier","type":"string","format":"uuid","example":"cc11c8a5-bbb3-4377-a33d-52a23b1455f9"},"value":{"description":"Display value","type":"string","example":"Regulatory"},"seeded":{"description":"Whether the value is seeded","type":"boolean","example":true},"sequence":{"description":"Sequence","type":"integer","format":"int32","example":0},"hint":{"description":"Optional hint","type":"string","example":"some-hint"},"hintKey":{"description":"Optional hint key","type":"string","example":"someHintKey"}}},"VendorInventoryCreateRequest":{"type":"object","properties":{"name":{"description":"Name of the inventory","type":"string","example":"Test Vendor","minLength":1},"organization":{"description":"Organization reference","example":{"value":"aws","id":"01d5d6db-a3f0-424e-9956-cfa205dc8af7"},"$ref":"#/components/schemas/ObjectReference"},"type":{"description":"Type reference","example":{"id":"cc11c8a5-bbb3-4377-a33d-52a23b1455f9","value":"Regulatory","seeded":true,"sequence":0},"$ref":"#/components/schemas/InventoryTypeReference"}},"required":["name","organization","type"]},"EntityInventoryCreateRequest":{"type":"object","properties":{"name":{"description":"Name of the inventory","type":"string","example":"Test Entity","minLength":1},"organization":{"description":"Organization reference","example":{"value":"aws","id":"01d5d6db-a3f0-424e-9956-cfa205dc8af7"},"$ref":"#/components/schemas/ObjectReference"},"primaryOperatingLocation":{"description":"Primary operating location reference (required for entities)","example":{"value":"US East","id":"b2c4d6e8-1234-5678-9abc-def012345678"},"$ref":"#/components/schemas/ObjectReference"}},"required":["name","organization","primaryOperatingLocation"]},"PAInventoryCreateRequest":{"type":"object","properties":{"name":{"description":"Name of the inventory","type":"string","example":"Test Processing Activity","minLength":1},"organization":{"description":"Organization reference","example":{"value":"aws","id":"01d5d6db-a3f0-424e-9956-cfa205dc8af7"},"$ref":"#/components/schemas/ObjectReference"}},"required":["name","organization"]},"BulkUpsertInventoryResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"organization":{"$ref":"#/components/schemas/ObjectReference"},"businessOwners":{"type":"array","items":{"$ref":"#/components/schemas/ObjectReference"}},"inventoryType":{"type":"string"},"number":{"type":"integer","format":"int64"},"externalId":{"type":"string"},"isNew":{"type":"boolean"},"detailsUri":{"type":"string"},"new":{"type":"boolean"}},"required":["name","organization"]},"InventoryAssociationUpdateRequest":{"type":"object","properties":{"relation":{"description":"The type of relationship between inventory records","type":"string","example":"JointControllerLinkType","enum":["ControllerLinkType","JointControllerLinkType","RelatedLinkType","RecipientOfSaleLinkType","SubProcessorLinkType","ProcessorLinkType","DestinationAccessLinkType","ProductOrServiceProviderLinkType","StorageProcessingLinkType","SourceCollectionLinkType"]},"InventoryType":{"type":"string","example":"vendors","enum":["processing-activities","vendors","assets","entities"]},"Ids":{"type":"array","items":{"type":"string","format":"uuid"},"example":["a1087fcb-1058-40ba-8c36-43dfafc0bba8","f9d7a8f1-af0d-418e-9092-e860307a48a3"]}},"required":["Ids","InventoryType"]},"InventoryAssociationRequest":{"type":"object","properties":{"relation":{"description":"The type of relationship between inventory records","type":"string","example":"JointControllerLinkType","enum":["ControllerLinkType","JointControllerLinkType","RelatedLinkType","RecipientOfSaleLinkType","SubProcessorLinkType","ProcessorLinkType","DestinationAccessLinkType","ProductOrServiceProviderLinkType","StorageProcessingLinkType","SourceCollectionLinkType"]}}},"PersonalDataLinkAttributesRequest":{"type":"object","properties":{"linkAttributes":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/InventoryValue"}}}}},"InventoryControlImplementationsRequest":{"type":"object","properties":{"controlIds":{"description":"Set of control IDs to be implemented for the given inventory entity","type":"array","items":{"type":"string","format":"uuid"},"example":["a8d2f0c6-63e5-476b-b600-79a447251a2a","b9e3f1d7-74f6-587c-c711-8ba558362b3b"],"uniqueItems":true},"status":{"description":"Implementation status of the controls being added to the inventory. If not provided, defaults to 'Pending'","type":"string","example":"Implemented","enum":["Implemented","Not Implemented","Partially Implemented","Not Applicable","Pending"]}},"required":["controlIds"]},"OneTrustMetadata":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/OneTrustPage"}}},"OneTrustPage":{"type":"object","properties":{"first":{"type":"boolean"},"last":{"type":"boolean"},"number":{"type":"integer","format":"int64"},"size":{"type":"integer","format":"int64"},"totalElements":{"type":"integer","format":"int64"},"totalPages":{"type":"integer","format":"int64"},"sort":{"type":"array","items":{"$ref":"#/components/schemas/OneTrustSort"}}}},"OneTrustResponse":{"type":"object","properties":{"data":{"type":"object"},"errors":{"type":"array","items":{"type":"object"}},"meta":{"$ref":"#/components/schemas/OneTrustMetadata"}}},"OneTrustSort":{"type":"object","properties":{"direction":{"type":"string","enum":["ASC","DESC"]},"property":{"type":"string"}}},"InventoriesPaginatedListResponseMeta":{"type":"object","properties":{"page":{"description":"Pagination information","$ref":"#/components/schemas/InventoriesPaginatedListResponsePage"}}},"InventoriesPaginatedListResponsePage":{"type":"object","properties":{"first":{"type":"boolean","example":true},"last":{"type":"boolean","example":true},"number":{"type":"integer","format":"int32","example":0},"size":{"type":"integer","format":"int32","example":20},"totalElements":{"type":"integer","format":"int64","example":1},"totalPages":{"type":"integer","format":"int32","example":1},"sort":{"description":"Sort information","type":"array","items":{"$ref":"#/components/schemas/InventoriesPaginatedListResponseSort"}}}},"InventoriesPaginatedListResponseSort":{"type":"object","properties":{"direction":{"type":"string","example":"ASC"},"property":{"type":"string","example":"name"}}},"VendorInventoriesPaginatedListResponse":{"type":"object","properties":{"data":{"description":"List of inventories","type":"array","items":{"$ref":"#/components/schemas/VendorInventory"}},"meta":{"description":"Response metadata","$ref":"#/components/schemas/InventoriesPaginatedListResponseMeta"}}},"AssetInventoriesPaginatedListResponse":{"type":"object","properties":{"data":{"description":"List of inventories","type":"array","items":{"$ref":"#/components/schemas/AssetInventory"}},"meta":{"description":"Response metadata","$ref":"#/components/schemas/InventoriesPaginatedListResponseMeta"}}},"EntityInventoriesPaginatedListResponse":{"type":"object","properties":{"data":{"description":"List of inventories","type":"array","items":{"$ref":"#/components/schemas/EntityInventory"}},"meta":{"description":"Response metadata","$ref":"#/components/schemas/InventoriesPaginatedListResponseMeta"}}},"InventoriesPaginatedListResponse":{"type":"object","properties":{"data":{"description":"List of inventories","type":"array","items":{"$ref":"#/components/schemas/Inventory"}},"meta":{"description":"Response metadata","$ref":"#/components/schemas/InventoriesPaginatedListResponseMeta"}}},"BasicInventoryFilterRequest":{"type":"object","properties":{"filters":{"description":"A list of criteria definitions to apply. All criteria in this list are typically combined with a logical AND.","type":"array","items":{"$ref":"#/components/schemas/CriteriaDefinition"},"example":[{"attributeKey":"name","operator":"CONTAINS","values":["Server"]},{"attributeKey":"status.key","operator":"EQUALS","values":["active"]}]}}},"CriteriaDefinition":{"type":"object","properties":{"attributeKey":{"description":"The key or path of the attribute to filter on (e.g., 'name', 'status.key', 'customFields.someCustomField').","type":"string","example":"name"},"dataType":{"description":"The data type of the attribute being filtered. (Note: Consider replacing with a more descriptive enum or String if specific integer values have meanings, e.g., 0 for String, 1 for Number, 2 for Date). For now, assuming it's an internal type identifier.","type":"integer","format":"int32","example":0,"enum":["0","1","2"]},"operator":{"description":"The operator to use for comparing the attribute with the provided values (e.g., EQUALS, CONTAINS, GREATER_THAN).","type":"string","example":"CONTAINS","enum":["FilterOperator.EQUAL_TO(description=Equal To)","FilterOperator.EQ(description=Equals)","FilterOperator.LT(description=LessThan)","FilterOperator.GT(description=GreaterThan)","FilterOperator.LE(description=LessThanOrEquals)","FilterOperator.GE(description=GreaterThanOrEquals)","FilterOperator.IN_BETWEEN(description=InBetween)","FilterOperator.CONTAINS(description=Contains)","FilterOperator.DOES_NOT_CONTAIN(description=DoesNotContain)","EQUAL_TO","EQ","LT","GT","LE","GE","IN_BETWEEN","CONTAINS","DOES_NOT_CONTAIN"]},"values":{"description":"An array of string values to match against the attribute. For operators like 'IN', multiple values can be provided. For others, typically one value is used.","type":"array","items":{"type":"string"},"example":["Server Alpha","Server Beta"]},"date":{"description":"A DTO for specifying date values, used when the attribute is a date type and the operator requires date comparison (e.g., DATE_EQUALS, DATE_BETWEEN).","$ref":"#/components/schemas/DateDto"}}},"DateDto":{"type":"object","properties":{"fromDateValue":{"description":"The start date for a date range filter, or the specific date if toDateValue is not provided or is the same. Expected format: YYYY-MM-DD.","type":"string","example":"2023-01-01","maxLength":60,"minLength":0},"toDateValue":{"description":"The end date for a date range filter. If filtering for a single day, this can be the same as fromDateValue or omitted if the operator implies a single date. Expected format: YYYY-MM-DD.","type":"string","example":"2023-01-31","maxLength":60,"minLength":0}},"required":["fromDateValue"]},"InventoryAssociationCreateRequest":{"type":"object","properties":{"relation":{"description":"The type of relationship between inventory records","type":"string","example":"JointControllerLinkType","enum":["ControllerLinkType","JointControllerLinkType","RelatedLinkType","RecipientOfSaleLinkType","SubProcessorLinkType","ProcessorLinkType","DestinationAccessLinkType","ProductOrServiceProviderLinkType","StorageProcessingLinkType","SourceCollectionLinkType"]},"id":{"description":"The unique identifier of the inventory record to link to","type":"string","format":"uuid","example":"d31425ae-1321-4738-bb76-bdca83c0944c"},"entityType":{"description":"The type of the inventory entity","type":"string","example":"vendors"}},"required":["id"]},"BaseInventoryAssociationDto":{"type":"object","properties":{"inventoryId":{"description":"The unique identifier of the linked inventory record","type":"string","format":"uuid","example":"9a7c3ec1-7830-4811-8563-36e0a093e7ae"},"inventoryAssociationId":{"description":"The unique identifier of the association between inventory records","type":"string","format":"uuid","example":"4374d5da-44ac-4308-a298-3efdb0f34ba4"}}},"DataSubjectResponse":{"type":"object","properties":{"id":{"description":"Unique identifier of the entity","type":"string","format":"uuid","example":"43fd3a8d-3f6b-464e-bf43-3f0c6c592442"},"name":{"description":"Name of the entity","type":"string","example":"Financial Data"},"nameKey":{"description":"Translation key for the entity name","type":"string","example":"financial_data_name"},"description":{"description":"Description of the entity","type":"string","example":"Contains financial information of customers"},"descriptionKey":{"description":"Translation key for the entity description","type":"string","example":"financial_data_description"},"source":{"description":"Source of the data subject","type":"string","example":"SYSTEM","enum":["SYSTEM","USER","IMPORTED"]},"visible":{"type":"boolean"}},"required":["id","name","nameKey"]},"DataSubjectCreateUpdateRequest":{"type":"object","properties":{"value":{"description":"Name of the personal data entity","type":"string","example":"Financial Data","maxLength":400,"minLength":0},"description":{"description":"Description of the personal data entity","type":"string","example":"Contains financial information of customers","maxLength":2000,"minLength":0},"status":{"description":"Status of the personal data entity","type":"string","example":"Active","enum":["Active","Inactive","Draft"],"maxLength":50,"minLength":0},"termId":{"description":"ID of the associated term","type":"string","format":"uuid","example":"43fd3a8d-3f6b-464e-bf43-3f0c6c592442"},"tagId":{"description":"ID of the associated tag","type":"string","format":"uuid","example":"43fd3a8d-3f6b-464e-bf43-3f0c6c592442"}},"example":{"value":"Customer","description":"End user of the service","status":"Active"},"required":["value"]},"BasePersonalDataResponse":{"type":"object","properties":{"id":{"description":"Unique identifier of the entity","type":"string","format":"uuid","example":"43fd3a8d-3f6b-464e-bf43-3f0c6c592442"},"name":{"description":"Name of the entity","type":"string","example":"Financial Data"},"nameKey":{"description":"Translation key for the entity name","type":"string","example":"financial_data_name"},"description":{"description":"Description of the entity","type":"string","example":"Contains financial information of customers"},"descriptionKey":{"description":"Translation key for the entity description","type":"string","example":"financial_data_description"}},"required":["id","name","nameKey"]},"DataCategoryResponse":{"type":"object","properties":{"id":{"description":"Unique identifier of the entity","type":"string","format":"uuid","example":"43fd3a8d-3f6b-464e-bf43-3f0c6c592442"},"name":{"description":"Name of the entity","type":"string","example":"Financial Data"},"nameKey":{"description":"Translation key for the entity name","type":"string","example":"financial_data_name"},"description":{"description":"Description of the entity","type":"string","example":"Contains financial information of customers"},"descriptionKey":{"description":"Translation key for the entity description","type":"string","example":"financial_data_description"},"source":{"description":"Source of the data category","type":"string","example":"SYSTEM","enum":["SYSTEM","USER","IMPORTED"]}},"required":["id","name","nameKey"]},"DataClassificationResponse":{"type":"object","properties":{"id":{"description":"Unique identifier of the entity","type":"string","format":"uuid","example":"43fd3a8d-3f6b-464e-bf43-3f0c6c592442"},"name":{"description":"Name of the entity","type":"string","example":"Financial Data"},"nameKey":{"description":"Translation key for the entity name","type":"string","example":"financial_data_name"},"description":{"description":"Description of the entity","type":"string","example":"Contains financial information of customers"},"descriptionKey":{"description":"Translation key for the entity description","type":"string","example":"financial_data_description"},"source":{"description":"Source of the data classification","type":"string","example":"SYSTEM","enum":["SYSTEM","USER","IMPORTED"]}},"required":["id","name","nameKey"]},"DataElementDetailedResponse":{"type":"object","properties":{"id":{"description":"Unique identifier of the entity","type":"string","format":"uuid","example":"43fd3a8d-3f6b-464e-bf43-3f0c6c592442"},"name":{"description":"Name of the entity","type":"string","example":"Financial Data"},"nameKey":{"description":"Translation key for the entity name","type":"string","example":"financial_data_name"},"description":{"description":"Description of the entity","type":"string","example":"Contains financial information of customers"},"descriptionKey":{"description":"Translation key for the entity description","type":"string","example":"financial_data_description"},"source":{"description":"Source of the data element","type":"string","example":"SYSTEM","enum":["SYSTEM","USER","IMPORTED"]},"status":{"description":"Status of the data element","type":"string","example":"Active","enum":["Active","Inactive","Draft"]},"dataSubjectTypes":{"description":"List of data subject types associated with this data element","type":"array","items":{"$ref":"#/components/schemas/BasePersonalDataResponse"}},"categories":{"description":"List of data categories associated with this data element","type":"array","items":{"$ref":"#/components/schemas/DataCategoryResponse"}},"classifications":{"description":"List of data classifications associated with this data element","type":"array","items":{"$ref":"#/components/schemas/DataClassificationResponse"}},"visible":{"type":"boolean"}},"required":["categories","id","name","nameKey"]},"DataElementCreateRequest":{"type":"object","properties":{"value":{"description":"Name of the personal data entity","type":"string","example":"Financial Data","maxLength":400,"minLength":0},"description":{"description":"Description of the personal data entity","type":"string","example":"Contains financial information of customers","maxLength":2000,"minLength":0},"status":{"description":"Status of the personal data entity","type":"string","example":"Active","enum":["Active","Inactive","Draft"],"maxLength":50,"minLength":0},"termId":{"description":"ID of the associated term","type":"string","format":"uuid","example":"43fd3a8d-3f6b-464e-bf43-3f0c6c592442"},"tagId":{"description":"ID of the associated tag","type":"string","format":"uuid","example":"43fd3a8d-3f6b-464e-bf43-3f0c6c592442"},"categories":{"description":"List of data categories to associate with the data element","type":"array","items":{"$ref":"#/components/schemas/ObjectReference"},"minItems":1},"classifications":{"description":"List of data classifications to associate with the data element","type":"array","items":{"$ref":"#/components/schemas/ObjectReference"}},"subjects":{"description":"List of data subjects to associate with the data element","type":"array","items":{"$ref":"#/components/schemas/ObjectReference"}},"assignToAllSubjects":{"description":"Flag indicating whether to assign the data element to all subjects","type":"boolean","default":"false"}},"example":{"value":"Email Address","description":"Customer email address","categories":[{"id":"43fd3a8d-3f6b-464e-bf43-3f0c6c592442"}]},"required":["categories","value"]},"DataClassificationCreateUpdateRequest":{"type":"object","properties":{"value":{"description":"Name of the personal data entity","type":"string","example":"Financial Data","maxLength":400,"minLength":0},"description":{"description":"Description of the personal data entity","type":"string","example":"Contains financial information of customers","maxLength":2000,"minLength":0},"status":{"description":"Status of the personal data entity","type":"string","example":"Active","enum":["Active","Inactive","Draft"],"maxLength":50,"minLength":0},"termId":{"description":"ID of the associated term","type":"string","format":"uuid","example":"43fd3a8d-3f6b-464e-bf43-3f0c6c592442"},"tagId":{"description":"ID of the associated tag","type":"string","format":"uuid","example":"43fd3a8d-3f6b-464e-bf43-3f0c6c592442"}},"example":{"value":"Sensitive","description":"Classification for sensitive information","status":"Active"},"required":["value"]},"DataCategoryCreateUpdateRequest":{"type":"object","properties":{"value":{"description":"Name of the personal data entity","type":"string","example":"Financial Data","maxLength":400,"minLength":0},"description":{"description":"Description of the personal data entity","type":"string","example":"Contains financial information of customers","maxLength":2000,"minLength":0},"status":{"description":"Status of the personal data entity","type":"string","example":"Active","enum":["Active","Inactive","Draft"],"maxLength":50,"minLength":0},"termId":{"description":"ID of the associated term","type":"string","format":"uuid","example":"43fd3a8d-3f6b-464e-bf43-3f0c6c592442"},"tagId":{"description":"ID of the associated tag","type":"string","format":"uuid","example":"43fd3a8d-3f6b-464e-bf43-3f0c6c592442"}},"example":{"value":"Financial Data","description":"Category for financial information","status":"Active"},"required":["value"]},"SchemaSummaryDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"nameKey":{"type":"string"},"uri":{"type":"string"}}},"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"}}},"AssociatedAttributeResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":2000,"minLength":0},"fieldName":{"type":"string","maxLength":100,"minLength":0},"nameKey":{"type":"string","maxLength":400,"minLength":0},"description":{"type":"string","maxLength":2000,"minLength":0},"descriptionKey":{"type":"string","maxLength":400,"minLength":0},"status":{"type":"string","maxLength":50,"minLength":0},"responseType":{"type":"string","maxLength":2147483647,"minLength":0},"responseSubType":{"type":"string","enum":["Standard","Formula","Matrix","RollUp"]},"formula":{"type":"string"},"schemaName":{"type":"string","maxLength":50,"minLength":0},"hidden":{"type":"boolean"},"readOnly":{"type":"boolean"},"Attribute options":{"type":"array","items":{"$ref":"#/components/schemas/AttributeValueResponse"}}},"required":["hidden"]},"AttributeDataSourceDto":{"type":"object","properties":{"Attribute Data Source Key":{"type":"string","maxLength":256,"minLength":0},"Attribute Data Source Name":{"type":"string","maxLength":256,"minLength":0},"Attribute Data Source Name Key for translation":{"type":"string","maxLength":128,"minLength":0}},"required":["Attribute Data Source Key","Attribute Data Source Name","Attribute Data Source Name Key for translation"]},"AttributeDetailResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":2000,"minLength":0},"fieldName":{"type":"string","maxLength":100,"minLength":0},"nameKey":{"description":"Key used for name translation","type":"string","example":"VendorsName"},"description":{"description":"Description of the attribute","type":"string","example":"Name of the vendor"},"descriptionKey":{"description":"Key used for description translation","type":"string","example":"VendorsNameDesc"},"required":{"description":"Flag indicating if the attribute is required","type":"boolean","example":true},"status":{"description":"Status of the attribute","type":"string","example":"enabled","enum":["enabled","disabled"]},"attributeType":{"description":"Type of the attribute","type":"string","example":"none","enum":["none","users","locations","organizations","vendors","assets","entities","processing-activities","statuses"]},"responseType":{"description":"Response type of the attribute","type":"string","example":"single-select","enum":["text","date","single-select","multi-select","numerical-text","numerical-single-select","score","formula"]},"readOnly":{"description":"Flag indicating if the attribute is read-only","type":"boolean","example":false},"seeded":{"description":"Flag indicating if the attribute is seeded (system-provided)","type":"boolean","example":true},"hiddenAtInventory":{"description":"Flag indicating if the attribute is hidden at inventory detail view","type":"boolean","example":false},"trackedAtRelatedInventoryType":{"description":"Related inventory type where this attribute is tracked","type":"string","example":"vendors"},"source":{"description":"Source of the attribute","type":"string","example":"System","enum":["System","Custom","Vendorpedia"]},"dataSource":{"description":"Data source information for the attribute","$ref":"#/components/schemas/AttributeDataSourceDto"},"formula":{"description":"Formula expression for formula-type attributes","type":"string","example":"sum(Assets:customField1044,Entities:customField1001)"},"schemaName":{"description":"Name of the schema this attribute belongs to","type":"string","example":"Vendors"},"hidden":{"description":"Flag indicating if the attribute is hidden","type":"boolean","example":false},"allowLabels":{"description":"Flag indicating if the attribute allows labels","type":"boolean","example":false},"intakeQuestionKey":{"description":"Key for the intake question","type":"string","example":"VendorsIntakeQuestion1"},"intakeQuestion":{"description":"Intake question details","$ref":"#/components/schemas/IntakeQuestion"},"validationRuleId":{"description":"ID of the validation rule applied to this attribute","type":"string","example":"f17a3b03-62da-4448-b3bb-e56d4a2291c2"},"assignments":{"description":"Assignments for the Attribute","type":"array","items":{"$ref":"#/components/schemas/AbacBasicAssignmentInfo"}},"allowOther":{"type":"boolean"},"values":{"type":"array","items":{"$ref":"#/components/schemas/AttributeValueResponse"}},"autoUpdate":{"type":"boolean"},"attributeLaws":{"type":"array","items":{"$ref":"#/components/schemas/KeyNameDto"}},"responseSubType":{"description":"Sub-type of the response","type":"string","example":"Standard","enum":["Standard","Formula","Matrix","RollUp"]},"associatedAttributes":{"description":"List of associated attributes","type":"array","items":{"$ref":"#/components/schemas/AssociatedAttributeResponse"}}}},"AttributeValueResponse":{"type":"object","properties":{"id":{"description":"Unique identifier of the attribute value","type":"string","example":"91e37a36-ca61-499b-b3c3-7d556aef5cde"},"value":{"description":"Value of the attribute option","type":"string","example":"Option 1"},"valueKey":{"description":"Key used for value translation","type":"string","example":"VendorsOption1"},"hint":{"description":"Hint text for the attribute value","type":"string","example":"Select this option if..."},"hintKey":{"description":"Key used for hint translation","type":"string","example":"VendorsOption1Hint"},"status":{"description":"Status of the attribute value","type":"string","example":"enabled","enum":["enabled","disabled"]},"seeded":{"description":"Flag indicating if the attribute value is seeded (system-provided)","type":"boolean","example":true},"sequence":{"description":"Sequence number for ordering","type":"integer","format":"int32","example":1,"minimum":1},"colorCode":{"description":"Color code for visual representation","type":"string","example":"#FF5733"},"selectionValue":{"description":"Selection value for numerical attributes","type":"string","example":5}}},"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}}},"InventoryAssociationRemoveRequest":{"type":"object","properties":{"inventoryAssociationId":{"description":"The unique identifier of the association to remove","type":"string","format":"uuid","example":"d31425ae-1321-4738-bb76-bdca83c0944c"}},"required":["inventoryAssociationId"]}},"securitySchemes":{"OAUTH2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{hostname}/api/access/v1/oauth/token","scopes":{"INVENTORY":"Inventory Scope gives the user access to read/write operations","INVENTORY_READ":"Inventory Read Scope gives the user read-only access","INVENTORY_WRITE":"Inventory Write Scope gives the user write access"}}}}}}}