Get External Task

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

Method

GET /external-task/{id}

Parameters

Path Parameters

Name Description
id The id of the external task to be retrieved.

Result

A JSON object corresponding to the ExternalTask interface in the engine. Its properties are as follows:

Name Value Description
activityId String The id of the activity that this external task belongs to.
activityInstanceId String The id of the activity instance that the external task belongs to.
errorMessage String The error message that was supplied when the last failure of this task was reported.
executionId String The id of the execution that the external task belongs to.
id String The id of the external task.
lockExpirationTime String The date that the task's most recent lock expires or has expired.
processDefinitionId String The id of the process definition the external task is defined in.
processDefinitionKey String The key of the process definition the external task is defined in.
processInstanceId String The id of the process instance the external task belongs to.
tenantId String The id of the tenant the external task belongs to.
retries Number The number of retries the task currently has left.
suspended Boolean A flag indicating whether the external task is suspended or not.
workerId String The id of the worker that posesses or posessed the most recent lock.
priority Number The priority of the external task.
topicName String The topic name of the external task.

Response Codes

Code Media type Description
200 application/json Request successful.
404 application/json External task with the given id does not exist. See the Introduction for the error response format.

Example

Request

GET /external-task/anExternalTaskId

Response

{
  "activityId": "anActivityId",
  "activityInstanceId": "anActivityInstanceId",
  "errorMessage": "anErrorMessage",
  "executionId": "anExecutionId",
  "id": "anExternalTaskId",
  "lockExpirationTime": "2015-10-06T16:34:42.000+0200",
  "processDefinitionId": "aProcessDefinitionId",
  "processDefinitionKey": "aProcessDefinitionKey",
  "processInstanceId": "aProcessInstanceId",
  "tenantId": null,
  "retries": 3,
  "suspended": false,
  "workerId": "aWorkerId",
  "priority":0,
  "topicName": "aTopic"
}

On this Page: