Sign in
Job

Get Jobs

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

get/job

Request

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

Query parameters

jobIdstring

Filter by job id.

jobIdsstring

Filter by a comma-separated list of job ids.

jobDefinitionIdstring

Only select jobs which exist for the given job definition.

processInstanceIdstring

Only select jobs which exist for the given process instance.

processInstanceIdsstring

Only select jobs which exist for the given comma-separated list of process instance ids.

executionIdstring

Only select jobs which exist for the given execution.

processDefinitionIdstring

Filter by the id of the process definition the jobs run on.

processDefinitionKeystring

Filter by the key of the process definition the jobs run on.

activityIdstring

Only select jobs which exist for an activity with the given id.

withRetriesLeftboolean

Only select jobs which have retries left. Value may only be true, as false is the default behavior.

executableboolean

Only select jobs which are executable, i.e., retries > 0 and due date is null or due date is in the past. Value may only be true, as false is the default behavior.

timersboolean

Only select jobs that are timers. Cannot be used together with messages. Value may only be true, as false is the default behavior.

messagesboolean

Only select jobs that are messages. Cannot be used together with timers. Value may only be true, as false is the default behavior.

dueDatesstring

Only select jobs where the due date is lower or higher than the given date. Due date expressions are comma-separated and are structured as follows:

A valid condition value has the form operator_value. operator is the comparison operator to be used and value the date value as string.

Valid operator values are: gt - greater than; lt - lower than. value may not contain underscore or comma characters.

createTimesstring

Only select jobs created before or after the given date.

Create time expressions are comma-separated and are structured as follows:

A valid condition value has the form operator_value. operator is the comparison operator to be used and value the date value as string.

Valid operator values are: gt - greater than; lt - lower than. value may not contain underscore or comma characters.

withExceptionboolean

Only select jobs that failed due to an exception. Value may only be true, as false is the default behavior.

exceptionMessagestring

Only select jobs that failed due to an exception with the given message.

failedActivityIdstring

Only select jobs that failed due to an exception at an activity with the given id.

noRetriesLeftboolean

Only select jobs which have no retries left. Value may only be true, as false is the default behavior.

activeboolean

Only include active jobs. Value may only be true, as false is the default behavior.

suspendedboolean

Only include suspended jobs. Value may only be true, as false is the default behavior.

priorityLowerThanOrEqualsinteger

Only include jobs with a priority lower than or equal to the given value. Value must be a valid long value.

priorityHigherThanOrEqualsinteger

Only include jobs with a priority higher than or equal to the given value. Value must be a valid long value.

tenantIdInstring

Only include jobs which belong to one of the passed comma-separated tenant ids.

withoutTenantIdboolean

Only include jobs which belong to no tenant. Value may only be true, as false is the default behavior.

includeJobsWithoutTenantIdboolean

Include jobs which belong to no tenant. Can be used in combination with tenantIdIn. Value may only be true, as false is the default behavior.

acquiredboolean

Only select jobs which are acquired, i.e., lock expiration date is not null, lock expiration date is in future. Value may only be true, as false is the default behavior. This does not take account if the job is suspended. This filter can be used with the suspension filter.

sortBy'jobId' | 'executionId' | 'processInstanceId' | 'processDefinitionId' | 'processDefinitionKey' | 'jobPriority' | 'jobRetries' | 'jobDueDate' | '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 job.

jobDefinitionIdstring nullable

The id of the associated job definition.

dueDatestring date-time nullable

The date on which this job is supposed to be processed.

processInstanceIdstring nullable

The id of the process instance which execution created the job.

executionIdstring nullable

The specific execution id on which the job was created.

processDefinitionIdstring nullable

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

processDefinitionKeystring nullable

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

retriesinteger nullable

The number of retries this job has left.

exceptionMessagestring nullable

The message of the exception that occurred, the last time the job was executed. Is null when no exception occurred.

failedActivityIdstring nullable

The id of the activity on which the last exception occurred, the last time the job was executed. Is null when no exception occurred.

suspendedboolean nullable

A flag indicating whether the job is suspended or not.

priorityinteger nullable

The job's priority for execution.

tenantIdstring nullable

The id of the tenant which this job belongs to.

createTimestring date-time nullable

The date on which this job has been created.

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

Changes

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