openapi: 3.2.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: 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 paths: /api/datasubject/v2/requestqueues/{requestQueueRefId}/subtasks: get: operationId: getAllSubTaskByRefIdUsingGET summary: Get List of Subtasks by Request description: Use this API to retrieve a list of all subtasks associated with a specific request. The response will include details for each subtask along with the request approver, date created, and deadline. tags: - Subtasks 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 example: ZASHMHK2K7 - 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: 500 minimum: 1 example: 20 responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/PrivacyAutomation-DataSubjectRequestDSRAutomation_SubTaskListV2Dto' '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: createSubTaskUsingPOST summary: Add Subtask to Request description: Use this API to add a subtask to a request. tags: - Subtasks 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 example: ZASHMHK2K7 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PrivacyAutomation-DataSubjectRequestDSRAutomation_SubTaskCreateV2Dto' responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/PrivacyAutomation-DataSubjectRequestDSRAutomation_SubTaskV2Dto' '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}/subtasks/template: post: operationId: createSubTaskFromTemplateUsingPOST summary: Add Subtask to Request using Subtask Template description: Use this API to add a subtask to a request using a subtask template. The subtask template name must be provided to create the subtask with the template's configuration. tags: - Subtasks parameters: - name: requestQueueRefId in: path required: true schema: description: Request queue reference Id type: string example: ZASHMHK2K7 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PrivacyAutomation-DataSubjectRequestDSRAutomation_SubTaskFromTemplateV2Dto' responses: '201': description: Created content: '*/*': schema: $ref: '#/components/schemas/PrivacyAutomation-DataSubjectRequestDSRAutomation_SubTaskV2Dto' '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/subtasks: get: operationId: subtasksUsingGET summary: Get List of Subtasks description: '> ❗️ End of Support Notification > > As of January 1, 2026, this API is now deprecated. Any customers leveraging this API are encouraged to use the Get List of Subtasks by Criteria API. For more information, see OneTrust API Sunsetting & Deprecation Guidelines. Use this API to retrieve a list of all subtasks. The response will include details for each subtask along with the request approver, created date, and deadline. > 🗒 Things to Know > > - This API does not return subtasks in **Complete** status.' tags: - Subtasks x-onetrust: spec-label: https://developer.onetrust.com/onetrust/openapi/privacy-automation-data-subject-request-dsr-automation.json parameters: - name: language in: query required: false schema: description: "A language code that identifies the language in which the Request Type and Subject Type values should be returned, assuming translations are available for that language. \nExamples: language=en-us for English, language=de for German, language=es for Spanish, etc." type: string example: en-us - name: modifieddate in: query required: false schema: description: A date (yyyyMMdd). Include to retrieve a list of subtasks modified on or after the specified date. For example, if you want to retrieve subtasks modified on or after January 30, 2019, include the modifieddate=20190130 parameter in your query. type: string format: date example: 20190130 - name: status in: query required: false schema: description: 'To get a SubTasks according to Status. Examples: status=assigned' type: string example: assigned - name: openrequests in: query required: false schema: description: 'An optional parameter to show subtasks on open requests if set to true.if this parameter is set to false or omitted, the response will contain subtasks on all requests Examples: openrequests=true' type: boolean default: false example: true - 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 enum: - taskName,asc - taskName,desc - createdDate,asc - createdDate,desc - lastModifiedDate,asc - lastModifiedDate,desc example: createdDate,desc responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/PrivacyAutomation-DataSubjectRequestDSRAutomation_SubTaskListV2Dto' '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/subtasks/{subtaskID}: get: operationId: getSubtaskByIDUsingGET summary: Get Subtask description: Use this API to retrieve a single subtask by its unique identifier along with the assignee, deadline, and status. tags: - Subtasks x-onetrust: spec-label: https://developer.onetrust.com/onetrust/openapi/privacy-automation-data-subject-request-dsr-automation.json parameters: - name: subtaskID in: path required: true schema: description: Subtask ID type: string format: uuid example: e2d0f59e-3df0-4b1f-965d-d57547ed44ad - name: includeComments in: query required: false schema: description: Include comments in the response type: boolean default: false example: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PrivacyAutomation-DataSubjectRequestDSRAutomation_SubtaskByIdDto' '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 put: operationId: updateSubTaskUsingPUT summary: Update Subtask description: Use this API to update an existing subtask. tags: - Subtasks x-onetrust: spec-label: https://developer.onetrust.com/onetrust/openapi/privacy-automation-data-subject-request-dsr-automation.json parameters: - name: subtaskID in: path required: true schema: description: Sub-Task UUID type: string format: uuid example: e2d0f59e-3df0-4b1f-965d-d57547ed44ad requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PrivacyAutomation-DataSubjectRequestDSRAutomation_SubTaskUpdateV2Dto' 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/subtasks/{subtaskID}/add/discovery: put: operationId: addDataDiscoveryUsingPUT summary: Add Targeted Data Discovery Details to Subtask description: Use this API to add Targeted Data Discovery details to a subtask. tags: - Subtasks x-onetrust: spec-label: https://developer.onetrust.com/onetrust/openapi/privacy-automation-data-subject-request-dsr-automation.json parameters: - name: subtaskID in: path required: true schema: description: Sub-Task UUID type: string format: uuid example: e2d0f59e-3df0-4b1f-965d-d57547ed44ad requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PrivacyAutomation-DataSubjectRequestDSRAutomation_SubTaskDataDiscoveryRequest' example: Status: '25' key: value1 another key: value2 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/subtasks/{subtaskID}/complete: put: operationId: completeSubTaskUsingPUT summary: Complete Subtask description: Use this API to resolve an existing subtask, marking it as Complete. tags: - Subtasks x-onetrust: spec-label: https://developer.onetrust.com/onetrust/openapi/privacy-automation-data-subject-request-dsr-automation.json parameters: - name: subtaskID in: path required: true schema: description: Sub-Task UUID type: string format: uuid example: e2d0f59e-3df0-4b1f-965d-d57547ed44ad requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PrivacyAutomation-DataSubjectRequestDSRAutomation_SubTaskCompleteV2Dto' 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/subtasks/{subtaskID}/reprocess: put: operationId: reprocessSubtaskUsingPUT summary: Reprocess System Subtask description: 'Use this API to reprocess a system subtask. > 🗒 Things to Know > > - System subtasks in the **Complete** and **Ready for Review** statuses are not supported.' tags: - Subtasks x-onetrust: spec-label: https://developer.onetrust.com/onetrust/openapi/privacy-automation-data-subject-request-dsr-automation.json parameters: - name: subtaskID in: path required: true schema: description: Subtask ID type: string format: uuid example: e2d0f59e-3df0-4b1f-965d-d57547ed44ad requestBody: content: application/json: schema: $ref: '#/components/schemas/PrivacyAutomation-DataSubjectRequestDSRAutomation_ReprocessSystemSubtaskDto' responses: '200': description: OK content: application/json: schema: type: string '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/subtasks/{subtaskId}/status: put: operationId: updateSubtaskStatusUsingPUT summary: Update Subtask Status description: 'Use this API to update the status of an existing subtask. > 🗒 Things to Know > > - The following statuses can be passed as parameter values in the request: `IN_PROGRESS`, `FAILED`, `COMPLETED`, and `REJECTED`. > - The Resolution ID can only be passed if the subtask status is updated to `COMPLETED` or `REJECTED`.' tags: - Subtasks x-onetrust: spec-label: https://developer.onetrust.com/onetrust/openapi/privacy-automation-data-subject-request-dsr-automation.json parameters: - name: subtaskId in: path required: true schema: description: Subtask Id type: string format: uuid example: e2d0f59e-3df0-4b1f-965d-d57547ed44ad requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PrivacyAutomation-DataSubjectRequestDSRAutomation_UpdateSubtaskStatusRequest' responses: '200': description: OK content: '*/*': schema: type: boolean '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/v3/subtasks: post: operationId: getAllSubtasksV3UsingPost summary: Get List of Subtasks by Criteria description: Use this API to retrieve a list of all subtasks by filter criteria. tags: - Subtasks x-onetrust: spec-label: https://developer.onetrust.com/onetrust/openapi/privacy-automation-data-subject-request-dsr-automation.json parameters: - name: includeClosedSubtasks in: query required: false schema: description: Include closed subtasks in the response type: boolean default: false example: true - name: onlyActivatedSubtasks in: query required: false schema: description: Only include activated subtasks in the response type: boolean default: false example: true - 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 subTaskId ascending.' type: string enum: - requestTypeName,asc - requestTypeName,desc - subjectTypeName,asc - subjectTypeName,desc - taskName,asc - taskName,desc - subtaskDateCreated,asc - subtaskDateCreated,desc - subtaskDateUpdated,asc - subtaskDateUpdated,desc - requestDeadline,asc - requestDeadline,desc - requestDateCreated,asc - requestDateCreated,desc example: subtaskDateCreated,desc requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PrivacyAutomation-DataSubjectRequestDSRAutomation_SubTaskV3RequestDto' responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/PrivacyAutomation-DataSubjectRequestDSRAutomation_SubTaskV3Dto' '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_READ - DSAR_WRITE components: schemas: PrivacyAutomation-DataSubjectRequestDSRAutomation_SubTaskUpdateV2Dto: type: object properties: userEmail: description: Email of the user associated with the subtask type: string format: email example: user@example.com maxLength: 255 description: description: Description of the subtask type: string example: This subtask is for data discovery maxLength: 1000 minLength: 1 deadline: description: Deadline for the subtask type: string format: date-time example: '2023-09-08T12:49:47.920Z' reminder: description: Reminder date for the subtask type: string format: date-time example: '2023-09-05T12:49:47.920Z' required: description: Whether the subtask is required type: boolean example: true default: 'false' assignedTogroup: description: Whether the subtask is assigned to a group type: boolean example: false default: 'false' groupName: description: Name of the group if assigned to a group type: string example: Data Privacy Team maxLength: 255 taskName: description: Name of the task type: string example: Data Discovery maxLength: 100 minLength: 1 required: - description PrivacyAutomation-DataSubjectRequestDSRAutomation_SubtaskExposedFileDto: type: object properties: fileName: type: string example: smile.png fileId: type: string format: uuid example: 7fb76433-476b-46aa-9ddf-2933a56b049e required: - fileId - fileName PrivacyAutomation-DataSubjectRequestDSRAutomation_SubTaskListV2Dto: type: object properties: requestApprover: description: Approver of the parent request type: string example: John Doe requestQueueRefId: description: The request reference ID type: string example: SL244HWD6D requestOrgName: description: Organization name of the request type: string example: Example Organization subTaskStatus: description: Current status of the subtask type: string example: OPEN subTaskType: description: Type of the subtask type: string example: MANUAL subTaskName: description: Name of the subtask type: string example: Data Discovery subTaskDescription: description: Description of the subtask type: string example: Discover all data related to the subject subTaskAssignee: description: Person assigned to the subtask type: string example: Jane Smith subTaskRequired: description: Whether the subtask is required type: boolean example: true requestQueueDateCreated: description: Date when the parent request was created type: string format: date-time example: '2023-08-01T10:15:30Z' requestQueueDeadline: description: Deadline for the parent request type: string format: date-time example: '2023-09-01T10:15:30Z' subTaskCreatedDate: description: Date when the subtask was created type: string format: date-time example: '2023-08-02T14:30:45Z' subTaskLastUpdatedDate: description: Date when the subtask was last updated type: string format: date-time example: '2023-08-15T09:20:15Z' subTaskReminderDate: description: Reminder date for the subtask type: string format: date-time example: '2023-08-25T10:15:30Z' subTaskDeadline: description: Deadline for the subtask type: string format: date-time example: '2023-09-01T10:15:30Z' requestTypes: description: Types of the parent request type: array items: type: string example: - Data Portability - Update Data subjectTypes: description: Subject types of the parent request type: array items: type: string example: - Customer - Employee subTaskResolution: description: Resolution code for the subtask if completed or rejected type: string example: Completed Successfully requestQueueId: type: string format: uuid assignedToGroup: type: boolean subTaskId: type: string format: uuid PrivacyAutomation-DataSubjectRequestDSRAutomation_SubtaskExposedCommentDto: type: object properties: commentId: type: string format: uuid example: b1d99fa8-fb30-4501-81b4-9158e09c7c6f comment: type: string example:

qasdxcfvb n

commenterName: type: string example: abcd attachments: type: array items: $ref: '#/components/schemas/PrivacyAutomation-DataSubjectRequestDSRAutomation_SubtaskExposedFileDto' isEditable: type: boolean example: true isEdited: type: boolean example: true isInternal: type: boolean example: true required: - comment - commentId - commenterName PrivacyAutomation-DataSubjectRequestDSRAutomation_SubTaskV3RequestDto: type: object properties: RequestType: description: Filter subtasks by Request Type. Only subtasks belonging to requests with this Request Type will be retrieved. type: string example: Opt Out SubjectType: description: Filter subtasks by Subject Type. Only subtasks belonging to requests with this Subject Type will be retrieved. type: string example: Employee Organization: description: Filter subtasks by Organization. Subtasks in this organization and related child organizations will be retrieved if includeChildOrgs is true. type: string example: Brand A SystemName: description: Filter subtasks by integration system name. Only system subtasks associated with this system will be returned. type: string example: Office365 SubtaskStatus: type: array items: description: Filter subtasks by their current status. You can provide multiple status values to include subtasks in any of those statuses. enum: - Open - Not Run - Assigned - Unassigned - In Progress - Processing - Ready for Review - Completed - Failed - Deleted - Rejected example: Assigned SubtaskType: description: Filter subtasks by type - either 'manual' for user-created subtasks or 'system' for automated system subtasks. type: string example: system enum: - manual - system OpenRequests: description: When set to true, only subtasks belonging to open requests will be included in the results. If false or omitted, subtasks from both open and closed requests will be returned. type: boolean example: true default: 'false' SubtaskDateCreated: description: Filter subtasks by their creation date. Only subtasks created within this date range will be included in the results. Use ISO 8601 format. example: StartDate: '2021-01-01T00:00:00.000Z' EndDate: '2021-12-31T00:00:00.000Z' $ref: '#/components/schemas/PrivacyAutomation-DataSubjectRequestDSRAutomation_DateRangeDto' SubtaskDateUpdated: description: Filter subtasks by their last update date. Only subtasks updated within this date range will be included in the results. Use ISO 8601 format. example: StartDate: '2021-01-01T00:00:00.000Z' EndDate: '2021-12-31T00:00:00.000Z' $ref: '#/components/schemas/PrivacyAutomation-DataSubjectRequestDSRAutomation_DateRangeDto' RequestDeadline: description: 'A date range for outlining start date and end date. All subtasks with a Request Deadline within this range will be retrieved. Accepted date format: YYYY-MM-DDT00:HH:MM.SSSZ' example: '{StartDate:2021-01-01T00:00:00.000Z, EndDate: 2021-12-31T00:00:00.000Z}' $ref: '#/components/schemas/PrivacyAutomation-DataSubjectRequestDSRAutomation_DateRangeDto' RequestDateCreated: description: 'A date range for outlining start date and end date. All subtasks with a Request Created Date within this range will be retrieved. Accepted date format: YYYY-MM-DDT00:HH:MM.SSSZ' example: '{StartDate:2021-01-01T00:00:00.000Z, EndDate: 2021-12-31T00:00:00.000Z}' $ref: '#/components/schemas/PrivacyAutomation-DataSubjectRequestDSRAutomation_DateRangeDto' currentRequestStage: description: 'Filter subtasks by current request stage. Accepted values include: All default and custom request stages are supported.' type: array items: type: string example: - NEW - VERIFYING IDENTITY subtaskCreatedStage: description: 'Filter subtasks by subtask created stage. Accepted values include: All default and custom request stages are supported.' type: array items: type: string example: - NEW - VERIFYING IDENTITY language: description: Specifies the language code for localized field values in the response. Translations will be provided for this language if available. type: string example: en-us default: en-us IncludeChildOrgs: description: By default set to true if omitted. On true Subtasks of Child Organizations of the given Organization will be included.On False Subtasks of the given Organization will be included. Effective only if 'organization' value is provided. type: boolean example: true default: 'true' ExactSystemNameMatch: description: When set to true, performs exact match for SystemName instead of substring matching. This ensures only subtasks from systems with exact name match are returned. By default set to false for backward compatibility. type: boolean example: true default: 'false' PrivacyAutomation-DataSubjectRequestDSRAutomation_AttachmentV2Dto: type: object properties: fileName: description: Attached file name type: string example: sample.txt maxLength: 200 minLength: 1 fileId: description: ID of attached file type: string format: uuid example: 3b47744c-eebf-44bb-bf4c-680966a448dc statusId: description: Status ID of the attachment type: integer format: int64 example: 10 resourcePath: description: Resource path of the attachment type: string example: /storage/attachments/sample.txt maxLength: 1000 required: - fileId - fileName PrivacyAutomation-DataSubjectRequestDSRAutomation_DateRangeDto: type: object properties: StartDate: description: Start date for filter, provide in yyyy-MM-dd'T'HH:mm:ss.SSS'Z' format type: string example: '2019-05-31T12:43:24.173Z' EndDate: description: End date for filter, provide in yyyy-MM-dd'T'HH:mm:ss.SSS'Z' format type: string example: '2019-05-31T12:44:24.173Z' PrivacyAutomation-DataSubjectRequestDSRAutomation_SubTaskFromTemplateV2Dto: type: object properties: templateName: description: Name of the subtask template to use. type: string example: Subtask Template Example minLength: 1 workflowDetailId: description: Workflow detail ID type: string format: uuid example: e2d0f59e-3df0-4b1f-965d-d57547ed44ad PrivacyAutomation-DataSubjectRequestDSRAutomation_ReprocessSystemSubtaskDto: type: object properties: Comment: description: Internal comment to identify reason for reprocessing the subtask. Longer comments may impact system performance. type: string example: Reprocessing due to configuration update maxLength: 1500000 PrivacyAutomation-DataSubjectRequestDSRAutomation_SubTaskV3Dto: type: object properties: assignedToGroup: description: Indicates whether the subtask is assigned to a group rather than an individual. type: boolean example: false requestApprover: description: The name of the person who approved the parent request. type: string example: John Doe maxLength: 255 requestOrgName: description: The organization name associated with the request. type: string example: Example Organization maxLength: 255 requestQueueDateCreated: description: The date when the parent request was created. type: string format: date-time example: '2023-08-01T10:15:30Z' requestQueueDeadline: description: The deadline for the parent request. type: string format: date-time example: '2023-09-01T10:15:30Z' requestQueueId: description: The request unique ID type: string format: uuid example: e2d0f59e-3df0-4b1f-965d-d57547ed44ad requestQueueRefId: description: The request reference ID type: string example: SL244HWD6D maxLength: 10 minLength: 10 requesterEmail: description: The email address of the requester type: string format: email example: requester@example.com maxLength: 255 subTaskAssignee: description: The person assigned to the subtask type: string example: Jane Smith maxLength: 255 subTaskCreatedDate: description: The date when the subtask was created type: string format: date-time example: '2023-08-02T14:30:45Z' subTaskDeadline: description: The deadline for the subtask type: string format: date-time example: '2023-09-01T10:15:30Z' subTaskDescription: description: The description of the subtask type: string example: Discover all data related to the subject maxLength: 1000 subTaskId: description: The subtask unique ID type: string format: uuid example: f3e1a59e-4df0-5b2f-865d-e68658e55be subTaskLastUpdatedDate: description: The date when the subtask was last updated type: string format: date-time example: '2023-08-15T09:20:15Z' subTaskName: description: The name of the subtask type: string example: Data Discovery maxLength: 100 minLength: 1 subTaskReminderDate: description: The reminder date for the subtask type: string format: date-time example: '2023-08-25T10:15:30Z' subTaskRequired: description: Indicates whether the subtask is required type: boolean example: true default: 'false' subTaskStatus: description: The current status of the subtask type: string example: OPEN enum: - OPEN - ASSIGNED - IN_PROGRESS - COMPLETED - FAILED - READY_FOR_REVIEW - PROCESSING - NOT_RUN subTaskType: description: The type of the subtask type: string example: MANUAL enum: - MANUAL - SYSTEM_TASK subTaskResolution: description: The resolution code for the subtask if completed or rejected type: string example: Completed Successfully maxLength: 255 requestTypes: description: Types of the parent request type: array items: type: string example: - Data Portability - Update Data subjectTypes: description: Subject types of the parent request type: array items: type: string example: - Customer - Employee currentRequestStage: description: The current stage of the parent request type: string example: VERIFICATION maxLength: 100 subtaskCreatedStage: description: The stage when the subtask was created type: string example: NEW maxLength: 100 PrivacyAutomation-DataSubjectRequestDSRAutomation_UpdateSubtaskStatusRequest: type: object properties: comment: description: Comments can be updated for system subtask status call - this can be used for reason for failure. Longer comments may impact system performance. type: string example: Updating the status for this reason maxLength: 1500000 status: description: Status to be updated to completed or failed type: string example: FAILED enum: - IN_PROGRESS - FAILED - COMPLETED - REJECTED resolutionId: description: Resolution ID (can only be passed if the subtask status is updated to COMPLETED or REJECTED) type: string format: uuid example: e2d0f59e-3df0-4b1f-965d-d57547ed44ad required: - status PrivacyAutomation-DataSubjectRequestDSRAutomation_SubTaskV2Dto: type: object properties: subTaskId: description: The subtask unique ID type: string format: uuid example: e2d0f59e-3df0-4b1f-965d-d57547ed44ad requestQueueRefId: description: The request reference ID type: string example: SL244HWD6D maxLength: 10 minLength: 10 taskName: description: Name of the task type: string example: Data Discovery maxLength: 100 minLength: 1 status: description: Current status of the subtask type: string example: OPEN enum: - OPEN - ASSIGNED - IN_PROGRESS - COMPLETED - FAILED - READY_FOR_REVIEW - PROCESSING - NOT_RUN type: description: Type of the subtask type: string example: SYSTEM_TASK enum: - USER_TASK - SYSTEM_TASK deadline: description: Deadline for the subtask type: string format: date-time example: '2023-09-08T12:49:47.920Z' reminder: description: Reminder date for the subtask type: string format: date-time example: '2023-09-05T12:49:47.920Z' assignee: description: Person assigned to the subtask type: string example: John Doe maxLength: 255 workflowDetailId: description: Workflow detail ID type: string format: uuid example: e2d0f59e-3df0-4b1f-965d-d57547ed44ad workflowStatus: description: Workflow status code type: integer format: int64 example: 10 description: description: Description of the subtask type: string example: Discover all data related to the subject maxLength: 1000 required: description: Whether the subtask is required type: boolean example: true integrationSystemId: description: Integration system ID type: string format: uuid example: e2d0f59e-3df0-4b1f-965d-d57547ed44ad integrationWorkflowId: description: Integration workflow ID type: string format: uuid example: e2d0f59e-3df0-4b1f-965d-d57547ed44ad manualRun: type: boolean commentRequired: type: boolean resolutionRequired: type: boolean PrivacyAutomation-DataSubjectRequestDSRAutomation_SubTaskDataDiscoveryRequest: type: object example: Status: '25' another key: value2 key: value1 PrivacyAutomation-DataSubjectRequestDSRAutomation_SubtaskByIdDto: type: object properties: subTaskId: type: string format: uuid example: 3a60d96a-3514-4811-a8b8-d7b5df55435e requestQueueRefId: type: string example: SL244HWD6D requestQueueId: type: string format: uuid example: da229a24-d0fc-4610-87ec-d311cfc257e5 taskName: type: string example: Test subtask Name statusCode: type: integer format: int64 example: 10 status: type: string example: ASSIGNED type: type: string example: USER_TASK/SYSTEM_TASK integrationSystemId: type: string format: uuid example: b2788e00-2334-4dc9-bec3-617fa49753d7 integrationWorkflowId: type: string format: uuid example: 92d45f00-0dff-4979-8e0e-0409978b119e isGroup: type: boolean example: false isManualRun: type: boolean example: false required: type: boolean example: false deadline: type: string format: date-time example: '2019-10-07T13:00:00.000Z' reminder: type: string format: date-time example: '2019-10-03T13:00:00.000Z' userId: type: string format: uuid example: a5a40e1e-88bf-47f6-9a07-dee6da4c0619 assignee: type: string example: 2 workflowDetailId: type: string format: uuid example: f82ac6f4-788f-4e31-9c20-450cd7ab4667 workflowStage: type: string example: Stage1 taskDescription: type: string example: Stage1 subTaskV2CommentsDtoList: type: array items: $ref: '#/components/schemas/PrivacyAutomation-DataSubjectRequestDSRAutomation_SubtaskExposedCommentDto' subTaskResolution: type: string PrivacyAutomation-DataSubjectRequestDSRAutomation_SubTaskCreateV2Dto: type: object properties: userEmail: description: Email of the user associated with the subtask type: string format: email example: user@example.com maxLength: 255 description: description: Description of the subtask type: string example: This subtask is for data discovery maxLength: 1000 minLength: 1 deadline: description: Deadline for the subtask type: string format: date-time example: '2023-09-08T12:49:47.920Z' reminder: description: Reminder date for the subtask type: string format: date-time example: '2023-09-05T12:49:47.920Z' required: description: Whether the subtask is required type: boolean example: true default: 'false' assignedTogroup: description: Whether the subtask is assigned to a group type: boolean example: false default: 'false' groupName: description: Name of the group if assigned to a group type: string example: Data Privacy Team maxLength: 255 workflowDetailId: description: Workflow detail ID type: string format: uuid example: e2d0f59e-3df0-4b1f-965d-d57547ed44ad type: description: Type of the subtask (MANUAL or SYSTEM_TASK) type: string example: MANUAL enum: - MANUAL - SYSTEM_TASK integrationSystemId: description: Integration system ID type: string format: uuid example: e2d0f59e-3df0-4b1f-965d-d57547ed44ad integrationWorkflowId: description: Integration workflow ID type: string format: uuid example: e2d0f59e-3df0-4b1f-965d-d57547ed44ad commentRequired: description: Whether a comment is required when completing the subtask type: boolean example: true resolutionRequired: description: Whether a resolution is required when completing the subtask type: boolean example: true taskName: description: Name of the task type: string example: Data Discovery maxLength: 100 minLength: 1 manualRun: type: boolean required: - description - taskName PrivacyAutomation-DataSubjectRequestDSRAutomation_SubTaskCompleteV2Dto: type: object properties: comment: description: Comment for the subtask completion. Longer comments may impact system performance. type: string example: Task completed successfully maxLength: 1500000 minLength: 1 markAsComplete: description: Whether to mark the subtask as complete type: boolean example: true default: 'false' resolutionId: description: Resolution ID for the subtask type: string format: uuid example: e2d0f59e-3df0-4b1f-965d-d57547ed44ad attachments: description: List of attachments for the subtask type: array items: $ref: '#/components/schemas/PrivacyAutomation-DataSubjectRequestDSRAutomation_AttachmentV2Dto' required: - comment securitySchemes: PrivacyAutomation-DataSubjectRequestDSRAutomation_OAUTH2: type: oauth2 flows: clientCredentials: tokenUrl: https://{hostname}/api/access/v1/oauth/token scopes: DSAR_READ: Read-only access to DSAR objects scope for external systems DSAR_WRITE: Access to DSAR objects scope for external systems DSAR: Access to DSAR objects scope for external systems PrivacyAutomation-DROPManagement_OAUTH2: type: oauth2 flows: clientCredentials: tokenUrl: https://{hostname}/api/access/v1/oauth/token scopes: DSAR_WRITE: Access to DROP objects scope for external systems x-readme: explorer-enabled: false proxy-enabled: false metrics-enabled: false x-onetrust: spec-label: OpenAPI 3.1.0