Skip to main content
GET
/
history
/
external-task-log
Get External Task Logs
curl --request GET \
  --url http://{host}:{port}/{contextPath}/history/external-task-log \
  --header 'Authorization: Basic <encoded-value>'
[
  {
    "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"
  }
]

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Query Parameters

logId
string

Filter by historic external task log id.

externalTaskId
string

Filter by external task id.

topicName
string

Filter by an external task topic.

workerId
string

Filter by the id of the worker that the task was most recently locked by.

errorMessage
string

Filter by external task exception message.

activityIdIn
string

Only include historic external task logs which belong to one of the passed activity ids.

activityInstanceIdIn
string

Only include historic external task logs which belong to one of the passed activity instance ids.

executionIdIn
string

Only include historic external task logs which belong to one of the passed execution ids.

processInstanceId
string

Filter by process instance id.

processDefinitionId
string

Filter by process definition id.

processDefinitionKey
string

Filter by process definition key.

tenantIdIn
string

Only include historic external task log entries which belong to one of the passed and comma-separated tenant ids.

withoutTenantId
boolean

Only include historic external task log entries that belong to no tenant. Value may only be true, as false is the default behavior.

priorityLowerThanOrEquals
integer

Only include logs for which the associated external task had a priority lower than or equal to the given value. Value must be a valid long value.

priorityHigherThanOrEquals
integer

Only include logs for which the associated external task had a priority higher than or equal to the given value. Value must be a valid long value.

creationLog
boolean

Only include creation logs. Value may only be true, as false is the default behavior.

failureLog
boolean

Only include failure logs. Value may only be true, as false is the default behavior.

successLog
boolean

Only include success logs. Value may only be true, as false is the default behavior.

deletionLog
boolean

Only include deletion logs. Value may only be true, as false is the default behavior.

sortBy
enum<string>

Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter.

Available options:
timestamp,
externalTaskId,
topicName,
workerId,
retries,
priority,
activityId,
activityInstanceId,
executionId,
processInstanceId,
processDefinitionId,
processDefinitionKey,
tenantId
sortOrder
enum<string>

Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter.

Available options:
asc,
desc
firstResult
integer

Pagination of results. Specifies the index of the first result to return.

maxResults
integer

Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left.

Response

Request successful.

id
string | null

The id of the log entry.

externalTaskId
string | null

The id of the external task.

timestamp
string<date-time> | null

The time when the log entry has been written.

topicName
string | null

The topic name of the associated external task.

workerId
string | null

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

retries
integer | null

The number of retries the associated external task has left.

priority
integer | null

The execution priority the external task had when the log entry was created.

errorMessage
string | null

The message of the error that occurred by executing the associated external task.

activityId
string | null

The id of the activity on which the associated external task was created.

activityInstanceId
string | null

The id of the activity instance on which the associated external task was created.

executionId
string | null

The execution id on which the associated external task was created.

processInstanceId
string | null

The id of the process instance on which the associated external task was created.

processDefinitionId
string | null

The id of the process definition which the associated external task belongs to.

processDefinitionKey
string | null

The key of the process definition which the associated external task belongs to.

tenantId
string | null

The id of the tenant that this historic external task log entry belongs to.

creationLog
boolean | null

A flag indicating whether this log represents the creation of the associated external task.

failureLog
boolean | null

A flag indicating whether this log represents the failed execution of the associated external task.

successLog
boolean | null

A flag indicating whether this log represents the successful execution of the associated external task.

deletionLog
boolean | null

A flag indicating whether this log represents the deletion of the associated external task.

removalTime
string<date-time> | null

The time after which this log should be removed by the History Cleanup job. Default format yyyy-MM-dd'T'HH:mm:ss.SSSZ. For further information, please see the documentation

rootProcessInstanceId
string | null

The process instance id of the root process instance that initiated the process containing this log.