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

As of Version

product version 2020 Autumn | component version 

Request MethodPOST
Response FormatHTTP status code
Description

Retrieves the task specified by its taskId.

Optionally, the boolean query parameter includeProcessVariables can be specified.

Response HTTP status codes:

HTTP Status CodeMeaning
200The action was executed.
404

The specified task was not found.

Request Example

https://<host>/api-web/api/bpm/tasks/4345abc-acb3485739-ef3

Response Example

200 OK

response body
{
  "assignee": {
    "id": "string",
    "title": "string"
  },
  "attachments": [
    "string"
  ],
  "claimTime": "string",
  "createTime": "string",
  "description": "string",
  "formKey": "string",
  "id": "string",
  "initiator": {
    "id": "string",
    "title": "string"
  },
  "name": "string",
  "owner": {
    "id": "string",
    "title": "string"
  },
  "parentTaskId": "string",
  "processDefinition": {
    "description": "string",
    "id": "string",
    "idPrefix": "string",
    "name": "string"
  },
  "subject": "string",
  "suspended": true,
  "variables": [
    {
      "name": "string",
      "scope": "string",
      "type": "string",
      "value": {}
    }
  ]
}