Sign in

v1

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

Update Subtask Status

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.
put/api/datasubject/v2/subtasks/{subtaskId}/status

Path parameters

subtaskIdstring uuid required

Subtask Id

Request body

commentstring

Comments can be updated for system subtask status call - this can be used for reason for failure. Longer comments may impact system performance.

status'IN_PROGRESS' | 'FAILED' | 'COMPLETED' | 'REJECTED' required

Status to be updated to completed or failed

resolutionIdstring uuid

Resolution ID (can only be passed if the subtask status is updated to COMPLETED or REJECTED)

Example request

{
  "comment": "Updating the status for this reason",
  "status": "FAILED",
  "resolutionId": "e2d0f59e-3df0-4b1f-965d-d57547ed44ad"
}

Response

OK