OneTrust Privacy Automation — Data Subject Request (DSR) Automation

{"openapi":"3.1.0","info":{"title":"Privacy Automation - Data Subject Request (DSR) Automation","version":"1.0","contact":{"name":"OneTrust Support","url":"https://my.onetrust.com/s/contactsupport"},"license":{"name":"Apache 2.0","url":"https://www.apache.org/licenses/LICENSE-2.0"},"description":"The Privacy Rights Automation are used to manage, process, and fulfill data subject access requests (DSARs), including request creation, subtask management, resolution codes, verification methods, and audit history."},"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":"DROP Management","description":"APIs for managing DROP records and privacy requests","x-displayName":"DROP Management"},{"name":"Request Queues","description":"APIs used to create, search, update, and manage privacy request queues.","externalDocs":{"description":"OpenAPI 3.1.0 - Download Definition","url":"https://developer.onetrust.com/onetrust/openapi/privacy-automation-data-subject-request-dsr-automation.json"},"x-displayName":"Request Queues"},{"name":"Resolutions","description":"APIs used to create, update, delete, and retrieve resolution codes for privacy requests and subtasks.","externalDocs":{"description":"OpenAPI 3.1.0 - Download Definition","url":"https://developer.onetrust.com/onetrust/openapi/privacy-automation-data-subject-request-dsr-automation.json"},"x-displayName":"Resolutions"},{"name":"Results Summary","description":"APIs used to share results summaries.","externalDocs":{"description":"OpenAPI 3.1.0 - Download Definition","url":"https://developer.onetrust.com/onetrust/openapi/privacy-automation-data-subject-request-dsr-automation.json"},"x-displayName":"Results Summary"},{"name":"Subtasks","description":"APIs used to create, update, complete, and reprocess subtasks associated with privacy requests.","externalDocs":{"description":"OpenAPI 3.1.0 - Download Definition","url":"https://developer.onetrust.com/onetrust/openapi/privacy-automation-data-subject-request-dsr-automation.json"},"x-displayName":"Subtasks"},{"name":"Targeted Data Discovery","description":"APIs used to add, update, and retrieve structured or unstructured data discovery results linked to privacy requests.","externalDocs":{"description":"OpenAPI 3.1.0 - Download Definition","url":"https://developer.onetrust.com/onetrust/openapi/privacy-automation-data-subject-request-dsr-automation.json"},"x-displayName":"Targeted Data Discovery"},{"name":"Verification Methods","description":"APIs used to create, update, and retrieve methods for verifying a data subject's identity.","externalDocs":{"description":"OpenAPI 3.1.0 - Download Definition","url":"https://developer.onetrust.com/onetrust/openapi/privacy-automation-data-subject-request-dsr-automation.json"},"x-displayName":"Verification Methods"}],"paths":{"/api/datasubject/v2/datadiscovery/groups/{groupId}/requestqueues/{requestQueueRefId}":{"get":{"operationId":"getAllGroupAndAttachmentDetailsUsingGET","summary":"Get Targeted Data Discovery Group","description":"Use this API to retrieve results for a Targeted Data Discovery group for the specified request.","tags":["Targeted Data Discovery"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/privacy-automation-data-subject-request-dsr-automation.json"},"parameters":[{"name":"groupId","in":"path","required":true,"schema":{"description":"TDD Group Id","type":"string","format":"uuid"}},{"name":"requestQueueRefId","in":"path","required":true,"schema":{"description":"Request queue ref ID","type":"string"}},{"name":"includeAttachments","in":"query","required":false,"schema":{"description":"Set to true to include attachment information in the response. If false or omitted, attachments will not be included.","type":"boolean","default":false}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrivacyAutomation-DataSubjectRequestDSRAutomation_DataDiscoveryGroupV2Dto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"PrivacyAutomation-DataSubjectRequestDSRAutomation_OAUTH2":["DSAR","DSAR_READ","DSAR_WRITE"]}]}},"/api/datasubject/v2/datadiscovery/requestqueues/{requestQueueRefId}":{"get":{"operationId":"getAllGroupByRequestUsingGET","summary":"Get List of Targeted Data Discovery Groups","description":"Use this API to retrieve a list of all Targeted Data Discovery groups for the specified request. The response will include details for each group along with the corresponding group ID, name, and order.","tags":["Targeted Data Discovery"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/privacy-automation-data-subject-request-dsr-automation.json"},"parameters":[{"name":"requestQueueRefId","in":"path","required":true,"schema":{"description":"Request queue reference Id","type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PrivacyAutomation-DataSubjectRequestDSRAutomation_DataDiscoveryGroupResultV2Dto"}}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"PrivacyAutomation-DataSubjectRequestDSRAutomation_OAUTH2":["DSAR","DSAR_READ","DSAR_WRITE"]}]},"post":{"operationId":"dataDiscoveryUpdatesUsingPOST","summary":"Add Targeted Data Discovery Results Summary to Request","description":"Use this API to add Targeted Data Discovery results to a request.","tags":["Targeted Data Discovery"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/privacy-automation-data-subject-request-dsr-automation.json"},"parameters":[{"name":"requestQueueRefId","in":"path","required":true,"schema":{"description":"Request queue reference Id","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrivacyAutomation-DataSubjectRequestDSRAutomation_DataDiscoveryGroupDto"}}}},"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"PrivacyAutomation-DataSubjectRequestDSRAutomation_OAUTH2":["DSAR","DSAR_WRITE"]}]}},"/api/datasubject/v2/requestqueues":{"post":{"operationId":"createRequestQueueFromMessageUsingPOST","summary":"Create Request","description":"> ❗️ End of Support Notification\n>\n> As of March 3, 2022, this API is now deprecated. Any customers leveraging this API are encouraged to migrate to the [Create Request API](https://developer.onetrust.com/onetrust/reference/createrequestqueuev2usingpost). For more information, see [OneTrust API Sunsetting & Deprecation Guidelines](https://developer.onetrust.com/onetrust/reference/onetrust-api-sunsetting-deprecation-guidelines).\n\nUse this API to create a request for a given hosted web form. The webform must already be created.","tags":["Request Queues"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/privacy-automation-data-subject-request-dsr-automation.json"},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrivacyAutomation-DataSubjectRequestDSRAutomation_DSARRequestDto"}}}},"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"deprecated":true,"security":[{"PrivacyAutomation-DataSubjectRequestDSRAutomation_OAUTH2":["DSAR","DSAR_WRITE"]}]}},"/api/datasubject/v2/requestqueues/bulkdelete/{language}":{"put":{"operationId":"bulkDeleteUsingPUT","summary":"Delete Requests","description":"Use this API to delete requests in bulk. The associated subtasks, attachments, and Results Summaries will also be deleted. Request deletion is a permanent action that should be exercised with caution.","tags":["Request Queues"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/privacy-automation-data-subject-request-dsr-automation.json"},"parameters":[{"name":"language","in":"path","required":true,"schema":{"description":"A language code that identifies the language in which the request data should be returned, assuming translations are available for that language. \nExamples: en-us for English, de for German, fr for French, etc.","type":"string"},"example":"en-us"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrivacyAutomation-DataSubjectRequestDSRAutomation_RequestQueueBulkDeleteV2Dto"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrivacyAutomation-DataSubjectRequestDSRAutomation_RequestQueueBulkDeleteResponseDto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"PrivacyAutomation-DataSubjectRequestDSRAutomation_OAUTH2":["DSAR_WRITE"]}]}},"/api/datasubject/v2/requestqueues/delete-certificate/{requestRefId}":{"get":{"operationId":"getDeletionCertificateUsingGET","summary":"Get Deletion Certificate","description":"Use this API to retrieve a deletion certificate for a deleted request. The response will serve as the deletion certification and will include details such as the retention policy (if applicable), deletion date and time, and deletion mode.\n\n> 🗒 Things to Know\n>\n> - Certificate data is available only for requests deleted within the past 360 days.","tags":["Request Queues"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/privacy-automation-data-subject-request-dsr-automation.json"},"parameters":[{"name":"requestRefId","in":"path","required":true,"schema":{"description":"Deleted Request Reference ID (10-character ID that is unique to each request)","type":"string"},"example":"SL244HWD6D"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PrivacyAutomation-DataSubjectRequestDSRAutomation_DeletionCertificateV2DTO"}}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"PrivacyAutomation-DataSubjectRequestDSRAutomation_OAUTH2":["DSAR","DSAR_READ","DSAR_WRITE"]}]}},"/api/datasubject/v2/requestqueues/id/{requestQueueId}/requesthistory":{"get":{"operationId":"getRequestHistoryByIdUsingGET","summary":"Get Request Audit History","description":"Use this API to retrieve the audit history of a request. The response will include details such as field updates and the date and time when changes were made.","tags":["Request Queues"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/privacy-automation-data-subject-request-dsr-automation.json"},"parameters":[{"name":"requestQueueId","in":"path","required":true,"schema":{"description":"GUID that is unique to each request. This GUID can be obtained either from the response of the GET /requestqueues/{language} API orfrom the url by navigating to the request details page within the DSAR module in the application. If the request is deleted,obtain the ID by navigating to the request URL from the assignee email.","type":"string","format":"uuid"}},{"name":"page","in":"query","schema":{"description":"Results page you want to retrieve. Page number starts with 0 (0..N)","type":"integer","format":"int32","default":0,"minimum":0},"example":0},{"name":"size","in":"query","schema":{"description":"Number of records per page.","type":"integer","format":"int32","default":20,"maximum":500,"minimum":1},"example":20}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PrivacyAutomation-DataSubjectRequestDSRAutomation_RequestAuditInfoResponse"}}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"PrivacyAutomation-DataSubjectRequestDSRAutomation_OAUTH2":["DSAR","DSAR_READ","DSAR_WRITE"]}]}},"/api/datasubject/v2/requestqueues/results-summary/share/{requestQueueRefId}":{"post":{"operationId":"shareResultsSummaryUsingPOST","summary":"Share Results Summary","description":"Use this API to share data discovery results summary with the data subject via email. The API supports sharing results in CSV or PDF format. When sharing as PDF, you must provide a report template ID to customize the output format.\n\n> 🗒 Things to Know\n>\n> - The report template ID (not name) must be provided for PDF reports.\n> - The API processes sharing asynchronously. For tracking, you can either mark a specific subtask as complete\\n by providing the subtaskId (the request will auto-progress when the subtask is completed), or you can mark the entire request as complete using the markRequestAsComplete flag.\n> - Comments in the request body support HTML content and will be sanitized.\n> - The report name format is: `{YYYYMMD}_{RequestRefId}___Report` (e.g., `2025113_HMVBKRYTYE___Report`).","tags":["Results Summary"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/privacy-automation-data-subject-request-dsr-automation.json"},"parameters":[{"name":"requestQueueRefId","in":"path","description":"Request Reference ID (10-character ID that is unique to each request)","required":true,"schema":{"type":"string","maxLength":10,"minLength":10},"example":"HMVBKRYTYE"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/PrivacyAutomation-DataSubjectRequestDSRAutomation_CsvResultsSummaryShareRequest"},{"$ref":"#/components/schemas/PrivacyAutomation-DataSubjectRequestDSRAutomation_PdfResultsSummaryShareRequest"}]}}}},"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"PrivacyAutomation-DataSubjectRequestDSRAutomation_OAUTH2":["DSAR","DSAR_WRITE"]}]}},"/api/datasubject/v2/requestqueues/search/{language}":{"post":{"operationId":"searchForRequestUsingPOST","summary":"Search Requests","description":"Use this API to search for requests by key terms, such as the data subject’s first name, last name, email address, or request ID.","tags":["Request Queues"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/privacy-automation-data-subject-request-dsr-automation.json"},"parameters":[{"name":"language","in":"path","required":true,"schema":{"description":"A language code that identifies the language in which the request data should be searched, assuming translations are available for that language. \nExamples: en-us for English, de for German, fr for French, etc.","type":"string"},"example":"en-us"},{"name":"createddate","in":"query","required":false,"schema":{"description":"A date (yyyyMMdd). Include to retrieve a list of requests created on or after the specified date. For example, if you want to retrieve requests created on or after January 30, 2019, include the createddate=20190130 parameter in your query.","type":"string","format":"date"},"example":20190130},{"name":"page","in":"query","schema":{"description":"Results page you want to retrieve. Page number starts with 0 (0..N)","type":"integer","format":"int32","default":0,"minimum":0},"example":0},{"name":"size","in":"query","schema":{"description":"Number of records per page.","type":"integer","format":"int32","default":20,"maximum":500,"minimum":1},"example":20}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrivacyAutomation-DataSubjectRequestDSRAutomation_SearchV2Request"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrivacyAutomation-DataSubjectRequestDSRAutomation_SearchResultPage"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"PrivacyAutomation-DataSubjectRequestDSRAutomation_OAUTH2":["DSAR","DSAR_READ","DSAR_WRITE"]}]}},"/api/datasubject/v2/requestqueues/status/{requestTraceId}":{"get":{"operationId":"getRequestCreationLogsUsingGET","summary":"Get Request Creation Logs","description":"Use this API to retrieve the creation details of a request by trace ID. The response will return the created date, creation status, and request ID.\n\n> 👍\n>\n> For more information, see [Using the Asynchronous Request Creation API](https://my.onetrust.com/s/article/UUID-c35a2967-4869-e091-b957-f3819f20d55e?topicId=0TO1Q000000ItSgWAK).","tags":["Request Queues"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/privacy-automation-data-subject-request-dsr-automation.json"},"parameters":[{"name":"requestTraceId","in":"path","required":true,"schema":{"description":"Request trace ID","type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrivacyAutomation-DataSubjectRequestDSRAutomation_CreateRequestLogDto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"PrivacyAutomation-DataSubjectRequestDSRAutomation_OAUTH2":["DSAR","DSAR_READ","DSAR_WRITE"]}]}},"/api/datasubject/v2/requestqueues/{language}":{"get":{"operationId":"getAllRequestQueuesV2UsingGET","summary":"Get List of Requests","description":"Use this API to retrieve a list of all requests. The response will include details for each request along with the approver, date created, and data subject's first and last name.","tags":["Request Queues"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/privacy-automation-data-subject-request-dsr-automation.json"},"parameters":[{"name":"language","in":"path","required":true,"schema":{"description":"A language code that identifies the language in which the request data should be returned, assuming translations are available for that language. \nExamples: en-us for English, de for German, fr for French, etc.","type":"string"},"example":"en-us"},{"name":"modifieddate","in":"query","required":false,"schema":{"description":"A date (yyyyMMdd). Include to retrieve a list of requests modified on or after the specified date. For example, if you want to retrieve requests modified on or after January 30, 2019, include the modifieddate=20190130 parameter in your query.","type":"string","format":"date"},"example":20190130},{"name":"createddate","in":"query","required":false,"schema":{"description":"A date (yyyyMMdd). Include to retrieve a list of requests created on or after the specified date. For example, if you want to retrieve requests created on or after January 30, 2019, include the createddate=20190130 parameter in your query.","type":"string","format":"date"},"example":20190130},{"name":"status","in":"query","required":false,"schema":{"description":"Filter requests by stage name. Parameters must be URL encoded.","type":"string"},"example":"NEW"},{"name":"ignoreUserRequests","in":"query","required":false,"schema":{"description":"A flag to exclude requests associated with user if they are not associated with specified organization.","type":"boolean","default":false}},{"name":"page","in":"query","schema":{"description":"Results page you want to retrieve. Page number starts with 0 (0..N)","type":"integer","format":"int32","default":0,"minimum":0},"example":0},{"name":"size","in":"query","schema":{"description":"Number of records per page. Maximum page size allowed is 500","type":"integer","format":"int32","default":20,"maximum":500,"minimum":1},"example":20},{"name":"sort","in":"query","schema":{"description":"Sorting criteria in the format: property(,asc|desc). Default sort order is ascending.","type":"string"},"example":"createdDate,desc"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PrivacyAutomation-DataSubjectRequestDSRAutomation_RequestQueueV2Dto"}}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"PrivacyAutomation-DataSubjectRequestDSRAutomation_OAUTH2":["DSAR","DSAR_READ","DSAR_WRITE"]}]}},"/api/datasubject/v2/requestqueues/{requestQueueRefId}/comments":{"put":{"operationId":"addCommentsUsingPUT","summary":"Add Comment to Request","description":"Use this API to add a comment to a request.","tags":["Request Queues"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/privacy-automation-data-subject-request-dsr-automation.json"},"parameters":[{"name":"requestQueueRefId","in":"path","required":true,"schema":{"description":"Request queue reference Id","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrivacyAutomation-DataSubjectRequestDSRAutomation_CommentV2Request"}}}},"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"PrivacyAutomation-DataSubjectRequestDSRAutomation_OAUTH2":["DSAR","DSAR_WRITE"]}]}},"/api/datasubject/v2/requestqueues/{requestQueueRefId}/customfields/{language}":{"put":{"operationId":"updateCustomFieldsUsingPUT","summary":"Update Request Custom Fields","description":"Use this API to update the fields of a request.","tags":["Request Queues"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/privacy-automation-data-subject-request-dsr-automation.json"},"parameters":[{"name":"requestQueueRefId","in":"path","required":true,"schema":{"description":"Reference ID of the request","type":"string"}},{"name":"language","in":"path","required":true,"schema":{"description":"A language code that identifies the language in which the request data should be returned after the move, assuming translations are available for that language. \nExamples: en-us for English, de for German, fr for French, etc.","type":"string"},"example":"en-us"},{"name":"mapOptionKeyToNameKey","in":"query","description":"If true, call will map form fields option keys with their respective form field name keys. If false or not included, field keys will not be mapped.","required":false,"schema":{"type":"boolean","default":false}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"string"}}}}},"responses":{"200":{"description":"OK","cont

# --- truncated at 32 KB (164 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/onetrust/refs/heads/main/openapi/onetrust-privacy-automation-data-subject-request-dsr-automation-openapi.json