Subtasks

Get Subtask

Use this API to retrieve a single subtask by its unique identifier along with the assignee, deadline, and status.

get/api/datasubject/v2/subtasks/{subtaskID}

Request

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

Path parameters

subtaskIDstring uuid required

Subtask ID

Query parameters

includeCommentsboolean

Include comments in the response

Response

OK

subTaskIdstring uuid
requestQueueRefIdstring
requestQueueIdstring uuid
taskNamestring
statusCodeinteger
statusstring
typestring
integrationSystemIdstring uuid
integrationWorkflowIdstring uuid
isGroupboolean
isManualRunboolean
requiredboolean
deadlinestring date-time
reminderstring date-time
userIdstring uuid
assigneestring
workflowDetailIdstring uuid
workflowStagestring
taskDescriptionstring
subTaskResolutionstring

Example response

{
  "subTaskId": "3a60d96a-3514-4811-a8b8-d7b5df55435e",
  "requestQueueRefId": "SL244HWD6D",
  "requestQueueId": "da229a24-d0fc-4610-87ec-d311cfc257e5",
  "taskName": "Test subtask Name",
  "statusCode": 10,
  "status": "ASSIGNED",
  "type": "USER_TASK/SYSTEM_TASK",
  "integrationSystemId": "b2788e00-2334-4dc9-bec3-617fa49753d7",
  "integrationWorkflowId": "92d45f00-0dff-4979-8e0e-0409978b119e",
  "deadline": "2019-10-07T13:00:00.000Z",
  "reminder": "2019-10-03T13:00:00.000Z",
  "userId": "a5a40e1e-88bf-47f6-9a07-dee6da4c0619",
  "workflowDetailId": "f82ac6f4-788f-4e31-9c20-450cd7ab4667",
  "workflowStage": "Stage1",
  "taskDescription": "Stage1",
  "subTaskV2CommentsDtoList": [
    {
      "commentId": "b1d99fa8-fb30-4501-81b4-9158e09c7c6f",
      "comment": "<p>qasdxcfvb n </p>",
      "commenterName": "abcd",
      "attachments": [
        {
          "fileName": "smile.png",
          "fileId": "7fb76433-476b-46aa-9ddf-2933a56b049e"
        }
      ],
      "isEditable": true,
      "isEdited": true,
      "isInternal": true
    }
  ]
}

Changes

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