Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Subtasks

Add Subtask to Request

Use this API to add a subtask to a request.

post/api/datasubject/v2/requestqueues/{requestQueueRefId}/subtasks

Path parameters

requestQueueRefIdstring required

Request queue reference Id

Request body

userEmailstring email

Email of the user associated with the subtask

descriptionstring required

Description of the subtask

deadlinestring date-time

Deadline for the subtask

reminderstring date-time

Reminder date for the subtask

requiredboolean

Whether the subtask is required

assignedTogroupboolean

Whether the subtask is assigned to a group

groupNamestring

Name of the group if assigned to a group

workflowDetailIdstring uuid

Workflow detail ID

type'MANUAL' | 'SYSTEM_TASK'

Type of the subtask (MANUAL or SYSTEM_TASK)

integrationSystemIdstring uuid

Integration system ID

integrationWorkflowIdstring uuid

Integration workflow ID

commentRequiredboolean

Whether a comment is required when completing the subtask

resolutionRequiredboolean

Whether a resolution is required when completing the subtask

taskNamestring required

Name of the task

manualRunboolean

Example request

{
  "userEmail": "user@example.com",
  "description": "This subtask is for data discovery",
  "deadline": "2023-09-08T12:49:47.920Z",
  "reminder": "2023-09-05T12:49:47.920Z",
  "required": true,
  "groupName": "Data Privacy Team",
  "workflowDetailId": "e2d0f59e-3df0-4b1f-965d-d57547ed44ad",
  "type": "MANUAL",
  "integrationSystemId": "e2d0f59e-3df0-4b1f-965d-d57547ed44ad",
  "integrationWorkflowId": "e2d0f59e-3df0-4b1f-965d-d57547ed44ad",
  "commentRequired": true,
  "resolutionRequired": true,
  "taskName": "Data Discovery"
}

Response

Created

subTaskIdstring uuid

The subtask unique ID

requestQueueRefIdstring

The request reference ID

taskNamestring

Name of the task

status'OPEN' | 'ASSIGNED' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED' | 'READY_FOR_REVIEW' | 'PROCESSING' | 'NOT_RUN'

Current status of the subtask

type'USER_TASK' | 'SYSTEM_TASK'

Type of the subtask

deadlinestring date-time

Deadline for the subtask

reminderstring date-time

Reminder date for the subtask

assigneestring

Person assigned to the subtask

workflowDetailIdstring uuid

Workflow detail ID

workflowStatusinteger

Workflow status code

descriptionstring

Description of the subtask

requiredboolean

Whether the subtask is required

integrationSystemIdstring uuid

Integration system ID

integrationWorkflowIdstring uuid

Integration workflow ID

manualRunboolean
commentRequiredboolean
resolutionRequiredboolean

Example response

{
  "subTaskId": "e2d0f59e-3df0-4b1f-965d-d57547ed44ad",
  "requestQueueRefId": "SL244HWD6D",
  "taskName": "Data Discovery",
  "status": "OPEN",
  "type": "SYSTEM_TASK",
  "deadline": "2023-09-08T12:49:47.920Z",
  "reminder": "2023-09-05T12:49:47.920Z",
  "assignee": "John Doe",
  "workflowDetailId": "e2d0f59e-3df0-4b1f-965d-d57547ed44ad",
  "workflowStatus": 10,
  "description": "Discover all data related to the subject",
  "required": true,
  "integrationSystemId": "e2d0f59e-3df0-4b1f-965d-d57547ed44ad",
  "integrationWorkflowId": "e2d0f59e-3df0-4b1f-965d-d57547ed44ad"
}