Skip to main content
POST
/
external-task
/
{id}
/
failure
Handle Failure
curl --request POST \
  --url http://{host}:{port}/{contextPath}/external-task/{id}/failure \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "workerId": "aWorker",
  "errorMessage": "Does not compute",
  "retries": 3,
  "retryTimeout": 60000
}'
This response does not have an example.

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 to report a failure for.

Body

application/json
​
errorMessage
string | null

An message indicating the reason of the failure.

​
errorDetails
string | null

A detailed error description.

​
retries
integer | null

A number of how often the task should be retried. Must be >= 0. If this is 0, an incident is created and the task cannot be fetched anymore unless the retries are increased again. The incident's message is set to the errorMessage parameter.

​
retryTimeout
integer | null

A timeout in milliseconds before the external task becomes available again for fetching. Must be >= 0.

​
variables
object | null

A JSON object containing variable key-value pairs. Each key is a variable name and each value a JSON variable value object with the following properties:

​
localVariables
object | null

A JSON object containing local variable key-value pairs. Local variables are set only in the scope of external task. Each key is a variable name and each value a JSON variable value object with the following properties:

​
workerId
string

Mandatory. The ID of the worker who is performing the operation on the external task. If the task is already locked, must match the id of the worker who has most recently locked the task.

Response

Request successful.