Sign in
External Task

Handle Failure

Reports a failure to execute an external task by id. A number of retries and a timeout until the task can be retried can be specified. If retries are set to 0, an incident for this task is created.

post/external-task/{id}/failure

Request

  • Base URL: http://localhost:8080/engine-rest
  • URL: http://localhost:8080/engine-rest/external-task/{id}/failure
  • Auth: HTTP basic

Path parameters

idstring required

The id of the external task to report a failure for.

Request body

errorMessagestring nullable

An message indicating the reason of the failure.

errorDetailsstring nullable

A detailed error description.

retriesinteger nullable

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.

retryTimeoutinteger nullable

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

variablesobject nullable

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:

localVariablesobject nullable

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:

workerIdstring

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.

Changes

No recorded changes to this operation across all 1 revision of this API.