Skip to main content
GET
/
external-task
/
{id}
Get
curl --request GET \
  --url http://{host}:{port}/{contextPath}/external-task/{id} \
  --header 'Authorization: Basic <encoded-value>'
{
  "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",
  "businessKey": "aBusinessKey"
}

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 be retrieved.

Response

Request successful.

An External Task object with the following properties

​
activityId
string | null

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

​
activityInstanceId
string | null

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

​
errorMessage
string | null

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

​
executionId
string | null

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

​
id
string | null

The id of the external task.

​
lockExpirationTime
string<date-time> | null

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

​
processDefinitionId
string | null

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

​
processDefinitionKey
string | null

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

​
processDefinitionVersionTag
string | null

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

​
processInstanceId
string | null

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

​
tenantId
string | null

The id of the tenant the external task belongs to.

​
retries
integer | null

The number of retries the task currently has left.

​
suspended
boolean | null

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

​
workerId
string | null

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

​
topicName
string | null

The topic name of the external task.

​
priority
integer | null

The priority of the external task.

​
businessKey
string | null

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