Job Definition

Get Job Definitions

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

get/job-definition

Request

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

Query parameters

jobDefinitionIdstring

Filter by job definition id.

activityIdInstring

Only include job definitions which belong to one of the passed and comma-separated activity ids.

processDefinitionIdstring

Only include job definitions which exist for the given process definition id.

processDefinitionKeystring

Only include job definitions which exist for the given process definition key.

jobTypestring

Only include job definitions which exist for the given job type. See the User Guide for more information about job types.

jobConfigurationstring

Only include job definitions which exist for the given job configuration. For example: for timer jobs it is the timer configuration.

activeboolean

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

suspendedboolean

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

withOverridingJobPriorityboolean

Only include job definitions that have an overriding job priority defined. The only effective value is true. If set to false, this filter is not applied.

tenantIdInstring

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

withoutTenantIdboolean

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

includeJobDefinitionsWithoutTenantIdboolean

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

sortBy'jobDefinitionId' | 'activityId' | 'processDefinitionId' | 'processDefinitionKey' | 'jobType' | 'jobConfiguration' | '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 definition.

processDefinitionIdstring nullable

The id of the process definition this job definition is associated with.

processDefinitionKeystring nullable

The key of the process definition this job definition is associated with.

activityIdstring nullable

The id of the activity this job definition is associated with.

jobTypestring nullable

The type of the job which is running for this job definition. See the User Guide for more information about job types.

jobConfigurationstring nullable

The configuration of a job definition provides details about the jobs which will be created. For example: for timer jobs it is the timer configuration.

overridingJobPriorityinteger nullable

The execution priority defined for jobs that are created based on this definition. May be null when the priority has not been overridden on the job definition level.

suspendedboolean nullable

Indicates whether this job definition is suspended or not.

tenantIdstring nullable

The id of the tenant this job definition is associated with.

deploymentIdstring nullable

The id of the deployment this job definition is related to. In a deployment-aware setup, this leads to all jobs of the same definition being executed on the same node.

Changes

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