Sign in
Historic External Task Log

Get External Task Logs

Queries for historic external task logs that fulfill the given parameters. The size of the result set can be retrieved by using the Get External Task Log Count method.

get/history/external-task-log

Request

  • Base URL: http://localhost:8080/engine-rest
  • URL: http://localhost:8080/engine-rest/history/external-task-log
  • Auth: HTTP basic

Query parameters

logIdstring

Filter by historic external task log id.

externalTaskIdstring

Filter by external task id.

topicNamestring

Filter by an external task topic.

workerIdstring

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

errorMessagestring

Filter by external task exception message.

activityIdInstring

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

activityInstanceIdInstring

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

executionIdInstring

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

processInstanceIdstring

Filter by process instance id.

processDefinitionIdstring

Filter by process definition id.

processDefinitionKeystring

Filter by process definition key.

tenantIdInstring

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

withoutTenantIdboolean

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

priorityLowerThanOrEqualsinteger

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.

priorityHigherThanOrEqualsinteger

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.

creationLogboolean

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

failureLogboolean

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

successLogboolean

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

deletionLogboolean

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

sortBy'timestamp' | 'externalTaskId' | 'topicName' | 'workerId' | 'retries' | 'priority' | 'activityId' | 'activityInstanceId' | 'executionId' | 'processInstanceId' | 'processDefinitionId' | 'processDefinitionKey' | 'tenantId'

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

sortOrder'asc' | 'desc'

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.

firstResultinteger

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

maxResultsinteger

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.

idstring nullable

The id of the log entry.

externalTaskIdstring nullable

The id of the external task.

timestampstring date-time nullable

The time when the log entry has been written.

topicNamestring nullable

The topic name of the associated external task.

workerIdstring nullable

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

retriesinteger nullable

The number of retries the associated external task has left.

priorityinteger nullable

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

errorMessagestring nullable

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

activityIdstring nullable

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

activityInstanceIdstring nullable

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

executionIdstring nullable

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

processInstanceIdstring nullable

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

processDefinitionIdstring nullable

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

processDefinitionKeystring nullable

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

tenantIdstring nullable

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

creationLogboolean nullable

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

failureLogboolean nullable

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

successLogboolean nullable

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

deletionLogboolean nullable

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

removalTimestring date-time nullable

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

rootProcessInstanceIdstring nullable

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

Changes

No recorded changes to this operation across all 1 revision of this API.