Skip to main content
POST
/
history
/
external-task-log
Get External Task Logs (POST)
curl --request POST \
  --url http://{host}:{port}/{contextPath}/history/external-task-log \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "externalTaskId": "anExternalTaskId"
}'
[
  {
    "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.

Body

application/json

A Historic External Task Log instance query which defines a list of Historic External Task Log instances

logId
string | null

Filter by historic external task log id.

externalTaskId
string | null

Filter by external task id.

topicName
string | null

Filter by an external task topic.

workerId
string | null

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

errorMessage
string | null

Filter by external task exception message.

activityIdIn
string[] | null

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

activityInstanceIdIn
string[] | null

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

executionIdIn
string[] | null

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

processInstanceId
string | null

Filter by process instance id.

processDefinitionId
string | null

Filter by process definition id.

processDefinitionKey
string | null

Filter by process definition key.

tenantIdIn
string[] | null

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

withoutTenantId
boolean | null

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 | null

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 | null

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 | null

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

failureLog
boolean | null

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

successLog
boolean | null

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

deletionLog
boolean | null

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

sorting
object[] | null

An array of criteria to sort the result by. Each element of the array is an object that specifies one ordering. The position in the array identifies the rank of an ordering, i.e., whether it is primary, secondary, etc. Sorting has no effect for count endpoints.

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.