GET /bpm-engine/api/tasks/{taskId}

As of Version

product version 2021 Autumn | component version 

Request MethodGET
Response FormatJSON
Description

Retrieves the task specified by taskId.

Optionally, the boolean query parameter includeProcessVariables can be added to the request URL in order to include process variables in the result. Default is false.

Meaning of HTTP status codes:

HTTP Status CodeDescription
200The task was found and returned.
401The calling user is not authorized.
404The requested task was not found.
Request HeaderContent-Type: application/json
Request Example
https://<host>/bpm-engine/api/tasks/187
Response Example
{
   "id": "187",
   "name": "1st_task",
   "description": "In this case, you have to do several things as they are:\n1. subtask\n2. subtask",
   "assignee": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
   "owner": aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaa5,
   "createTime": "2021-11-01T12:28:46.388Z",
   "claimTime": "2021-11-01T13:29:47.389Z",
   "processDefinitionId": "twosteptest_proc:4:8dc694a2-10b1-11ec-99ef-027ea5eeae02",
   "processInstanceId": "00000000-0000-0000-0000-000000000000",
   "parentTaskId": null,
   "formKey": "twosteptest_proc:1st_task",
   "taskDefinitionKey": "sid-4CAF2A19-B303-46C6-A7C0-2F506F1613D4",
   "delegationState": "pending",
   "suspended": true,
   "variables": [
     {
       "name": "whatabout",
       "type": "string",
       "value": "testValue",
       "scope": "global"
     },
     {
       "name": "initiator",
       "type": "string",
       "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaa5",
       "scope": "global"
     }
   ]
}