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

Owned by Technische Redaktion
Nov 12, 2021
1 min read
As of Version

product version 2021 Autumn | component version 

Request MethodPOST
Response FormatJSON
Description

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

Meaning of HTTP status codes:

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