Sign in
Historic Job Log

Get Job Logs (POST)

Queries for historic job logs that fulfill the given parameters. This method is slightly more powerful than the Get Job Logs method because it allows filtering by historic job logs values of the different types String, Number or Boolean.

post/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

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.

Request body

logIdstring nullable

Filter by historic job log id.

jobIdstring nullable

Filter by job id.

jobExceptionMessagestring nullable

Filter by job exception message.

jobDefinitionIdstring nullable

Filter by job definition id.

jobDefinitionTypestring nullable

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

jobDefinitionConfigurationstring nullable

Filter by job definition configuration.

activityIdInstring[] nullable

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

failedActivityIdInstring[] nullable

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

executionIdInstring[] nullable

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

processInstanceIdstring nullable

Filter by process instance id.

processDefinitionIdstring nullable

Filter by process definition id.

processDefinitionKeystring nullable

Filter by process definition key.

deploymentIdstring nullable

Filter by deployment id.

tenantIdInstring[] nullable

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

withoutTenantIdboolean nullable

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

hostnamestring nullable

Filter by hostname.

jobPriorityLowerThanOrEqualsinteger nullable

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 nullable

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 nullable

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

failureLogboolean nullable

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

successLogboolean nullable

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

deletionLogboolean nullable

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

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.