ONonetrust
Subtasks

Add Subtask to Request using Subtask Template

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.

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

Request

  • Base URL
    https://hostname
  • URL
    https://hostname/api/datasubject/v2/requestqueues/{requestQueueRefId}/subtasks/template
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://{hostname}/api/access/v1/oauth/token scopes: DSAR, DSAR_WRITE

Path parameters

requestQueueRefIdstring required

Request queue reference Id

Request body

templateNamestring

Name of the subtask template to use.

workflowDetailIdstring uuid

Workflow detail ID

Example request

{
  "templateName": "Subtask Template Example",
  "workflowDetailId": "e2d0f59e-3df0-4b1f-965d-d57547ed44ad"
}

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"
}

Changes

No recorded changes to this operation across all 1 revision of this API.