Skip to main content
POST
/
external-task
/
{id}
/
bpmnError
Handle BPMN Error
curl --request POST \
  --url http://{host}:{port}/{contextPath}/external-task/{id}/bpmnError \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "workerId": "aWorker",
  "errorCode": "bpmn-error",
  "errorMessage": "anErrorMessage",
  "variables": {
    "aVariable": {
      "value": "aStringValue",
      "type": "String"
    },
    "anotherVariable": {
      "value": true,
      "type": "Boolean"
    }
  }
}
'
{
  "type": "<string>",
  "message": "<string>",
  "code": 123
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

​
id
string
required

The id of the external task in which context a BPMN error is reported.

Body

application/json
​
workerId
string | null

The id of the worker that reports the failure. Must match the id of the worker who has most recently locked the task.

​
errorCode
string | null

An error code that indicates the predefined error. It is used to identify the BPMN error handler.

​
errorMessage
string | null

An error message that describes the error.

​
variables
object

A JSON object containing variable key-value pairs.

Response

Request successful.