Get External Task Log

Retrieves a historic external task log by id.

Method

GET /history/external-task-log/{id}

Parameters

Path Parameters

Name Description
id The id of the log entry.

Result

A JSON object with the following properties:

Name Value Description
id String The id of the log entry.
externalTaskId String The id of the external task.
timestamp String The time when the log entry has been written.
topicName String The topic name of the associated external task.
workerId String The id of the worker that posessed the most recent lock.
retries Number The number of retries the associated external task has left.
priority Number The execution priority the external task had when the log entry was created.
errorMessage String The message of the error that occurred by executing the associated external task.
activityId String The id of the activity on which the associated external task was created.
activityInstanceId String The id of the activity instance on which the associated external task was created.
executionId String The execution id on which the associated external task was created.
processInstanceId String The id of the process instance on which the associated external task was created.
processDefinitionId String The id of the process definition which the associated external task belongs to.
processDefinitionKey String The key of the process definition which the associated external task belongs to.
tenantId String The id of the tenant that this historic external task log entry belongs to.
creationLog boolean A flag indicating whether this log represents the creation of the associated external task.
failureLog boolean A flag indicating whether this log represents the failed execution of the associated external task.
successLog boolean A flag indicating whether this log represents the successful execution of the associated external task.
deletionLog boolean A flag indicating whether this log represents the deletion of the associated external task.
removalTime String The time after which this log should be removed by the History Cleanup job. Default format* yyyy-MM-dd'T'HH:mm:ss.SSSZ.
rootProcessInstanceId String The process instance id of the root process instance that initiated the process containing this log.

* For further information, please see the documentation.

Response Codes

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

Example

Request

GET /history/external-task-log/someId

Response

Status 200.

{
  "id" : "someId",
  "timestamp" : "2017-01-15T15:22:20.000+0200",
  "externalTaskId" : "anExternalTaskId",
  "topicName" : "aTopicName",
  "workerId" : "aWorkerId",
  "retries" : 3,
  "priority": 5,
  "errorMessage" : "An error occured!",
  "activityId" : "externalServiceTask",
  "activityInstanceId" : "externalServiceTask:15",
  "executionId" : "anExecutionId",
  "processInstanceId" : "aProcessInstanceId",
  "processDefinitionId" : "aProcessDefinitionId",
  "processDefinitionKey" : "aProcessDefinitionKey",
  "tenantId": null,
  "creationLog" : false,
  "failureLog" : true,
  "successLog" : false,
  "deletionLog" : false,
  "removalTime":"2018-02-10T14:33:19.000+0200",
  "rootProcessInstanceId": "aRootProcessInstanceId"
}

On this Page: