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

As of Version

product version 2021 Autumn | component version

Request Method POST

Response Format JSON

Description

Performs an action defined in the request body on the task specified by taskId.

In addition to the complete action and in contrast to the corresponding underlying Flowable task actions, the following actions allow to apply changes to variables as well:

delegate
resolve
Note: The specified values for the variables are updated even if the final resolving process fails.

Meaning of HTTP status codes:

HTTP Status Code	Description
200	The request was successful and the task is returned.
400	An invalid variable has been passed. Status description contains additional information about the error.
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

{
  "action": "claim",
  "assignee": "userWhoClaims",
  "variables": [
    {
      "name": "myVariable",
      "scope": "myScope",
      "type": "myType",
      "value": "test",
      "valueUrl": "http://...."
    }
  ]
}

Response Example

{
  "assignee": "userWhoClaims",
  "claimTime": "2018-04-17T10:17:43.902+0000",
  "createTime": "2013-04-17T10:17:43.902+0000",
  "description": "Task description",
  "formKey": "myKey",
  "id": 8,
  "name": "My task",
  "parentTaskId": "null",
  "processDefinitionId": 123,
  "processInstanceId": 123,
  "suspended": true,
  "variables": [
    {
      "name": "myVariable",
      "scope": "myScope",
      "type": "myType",
      "value": "test",
      "valueUrl": "http://...."
    }
  ]
}