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

As of Version

product version 2021 Autumn | component version

Request Method GET

Response Format JSON

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 Code	Description
200	The task was found and returned.
401	The calling user is not authorized.
404	The requested task was not found.

Request Header Content-Type: application/json

Request Example

https://<host>/bpm-engine/api/tasks/8

Response Example

{
  "id": "424ad031-3b0f-11ec-887b-12c18d9ef4aa",
  "name": "1st_task",
  "description": "In this case, you have to do several things as they are:\n1. subtask\n2. subtask",
  "assignee": "0ade86f3-fcd1-4149-a556-fac2e94dc578",
  "owner": null,
  "createTime": "2021-11-01T12:28:46.388Z",
  "claimTime": null,
  "processDefinitionId": "twosteptest_proc:4:8dc694a2-10b1-11ec-99ef-027ea5eeae02",
  "processInstanceId": "423f3769-3b0f-11ec-887b-12c18d9ef4aa",
  "parentTaskId": null,
  "formKey": "twosteptest_proc:1st_task",
  "taskDefinitionKey": "sid-4CAF2A19-B303-46C6-A7C0-2F506F1613D4",
  "delegationState": null,
  "suspended": false,
  "variables": [
    {
      "name": "whatabout",
      "type": "string",
      "value": "testValue",
      "scope": "global"
    },
    {
      "name": "initiator",
      "type": "string",
      "value": "0ade86f3-fcd1-4149-a556-fac2e94dc578",
      "scope": "global"
    }
  ]
}