Job

Get Jobs (POST)

Queries for jobs that fulfill given parameters. This method is slightly more powerful than the Get Jobs method because it allows filtering by multiple jobs of types String, Number or Boolean.

post/job

Request

  • Base URL: http://localhost:8080/engine-rest
  • URL: http://localhost:8080/engine-rest/job
  • 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

jobIdstring nullable

Filter by job id.

jobIdsstring[] nullable

Filter by a list of job ids.

jobDefinitionIdstring nullable

Only select jobs which exist for the given job definition.

processInstanceIdstring nullable

Only select jobs which exist for the given process instance.

processInstanceIdsstring[] nullable

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

executionIdstring nullable

Only select jobs which exist for the given execution.

processDefinitionIdstring nullable

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

processDefinitionKeystring nullable

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

activityIdstring nullable

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

withRetriesLeftboolean nullable

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

executableboolean nullable

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 nullable

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

messagesboolean nullable

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

withExceptionboolean nullable

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

exceptionMessagestring nullable

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

failedActivityIdstring nullable

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

noRetriesLeftboolean nullable

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

activeboolean nullable

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

suspendedboolean nullable

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

priorityLowerThanOrEqualsinteger nullable

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

priorityHigherThanOrEqualsinteger nullable

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

tenantIdInstring[] nullable

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

withoutTenantIdboolean nullable

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

includeJobsWithoutTenantIdboolean nullable

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 nullable

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.

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.