Sign in
Historic Job Log

Get Job Logs

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

get/history/job-log

Request

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

Query parameters

logIdstring

Filter by historic job log id.

jobIdstring

Filter by job id.

jobExceptionMessagestring

Filter by job exception message.

jobDefinitionIdstring

Filter by job definition id.

jobDefinitionTypestring

Filter by job definition type. See the User Guide for more information about job definition types.

jobDefinitionConfigurationstring

Filter by job definition configuration.

activityIdInstring

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

failedActivityIdInstring

Only include historic job logs which belong to failures of one of the passed activity ids.

executionIdInstring

Only include historic job 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.

deploymentIdstring

Filter by deployment id.

tenantIdInstring

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

withoutTenantIdboolean

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

hostnamestring

Filter by hostname.

jobPriorityLowerThanOrEqualsinteger

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

jobPriorityHigherThanOrEqualsinteger

Only include logs for which the associated job 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' | 'jobId' | 'jobDefinitionId' | 'jobDueDate' | 'jobRetries' | 'jobPriority' | 'activityId' | 'executionId' | 'processInstanceId' | 'processDefinitionId' | 'processDefinitionKey' | 'deploymentId' | 'hostname' | 'occurrence' | '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.

timestampstring date-time nullable

The time when the log entry has been written.

removalTimestring date-time nullable

The time after which the log entry should be removed by the History Cleanup job. Default format yyyy-MM-dd'T'HH:mm:ss.SSSZ. For further info see the docs

jobIdstring nullable

The id of the associated job.

jobDueDatestring date-time nullable

The date on which the associated job is supposed to be processed.

jobRetriesinteger nullable

The number of retries the associated job has left.

jobPriorityinteger nullable

The execution priority the job had when the log entry was created.

jobExceptionMessagestring nullable

The message of the exception that occurred by executing the associated job.

failedActivityIdstring nullable

The id of the activity on which the last exception occurred by executing the associated job.

jobDefinitionIdstring nullable

The id of the job definition on which the associated job was created.

jobDefinitionTypestring nullable

The job definition type of the associated job. See the User Guide for more information about job definition types.

jobDefinitionConfigurationstring nullable

The job definition configuration type of the associated job.

activityIdstring nullable

The id of the activity on which the associated job was created.

executionIdstring nullable

The execution id on which the associated job was created.

processInstanceIdstring nullable

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

processDefinitionIdstring nullable

The id of the process definition which the associated job belongs to.

processDefinitionKeystring nullable

The key of the process definition which the associated job belongs to.

deploymentIdstring nullable

The id of the deployment which the associated job belongs to.

rootProcessInstanceIdstring nullable

The process instance id of the root process instance that initiated the process which the associated job belongs to.

tenantIdstring nullable

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

hostnamestring nullable

The name of the host of the Process Engine where the job of this historic job log entry was executed.

batchIdstring nullable

The ID of the batch associated with this job. null if no batch is associated with this job. The following jobs are associated with batches:

  • Seed Jobs
  • Monitor Jobs
  • Batch Execution Jobs
creationLogboolean nullable

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

failureLogboolean nullable

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

successLogboolean nullable

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

deletionLogboolean nullable

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

Changes

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