Sign in
External Task

Get

Retrieves an external task by id, corresponding to the ExternalTask interface in the engine.

get/external-task/{id}

Request

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

Path parameters

idstring required

The id of the external task to be retrieved.

Response

Request successful.

activityIdstring nullable

The id of the activity that this external task belongs to.

activityInstanceIdstring nullable

The id of the activity instance that the external task belongs to.

errorMessagestring nullable

The full error message submitted with the latest reported failure executing this task; null if no failure was reported previously or if no error message was submitted

executionIdstring nullable

The id of the execution that the external task belongs to.

idstring nullable

The id of the external task.

lockExpirationTimestring date-time nullable

The date that the task's most recent lock expires or has expired.

processDefinitionIdstring nullable

The id of the process definition the external task is defined in.

processDefinitionKeystring nullable

The key of the process definition the external task is defined in.

processDefinitionVersionTagstring nullable

The version tag of the process definition the external task is defined in.

processInstanceIdstring nullable

The id of the process instance the external task belongs to.

tenantIdstring nullable

The id of the tenant the external task belongs to.

retriesinteger nullable

The number of retries the task currently has left.

suspendedboolean nullable

A flag indicating whether the external task is suspended or not.

workerIdstring nullable

The id of the worker that posesses or posessed the most recent lock.

topicNamestring nullable

The topic name of the external task.

priorityinteger nullable

The priority of the external task.

businessKeystring nullable

The business key of the process instance the external task belongs to.

createTimestring date-time nullable

The date that the task was created.

Changes

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