Skip to main content
GET
/
job-definition
Get Job Definitions
curl --request GET \
  --url http://{host}:{port}/{contextPath}/job-definition \
  --header 'Authorization: Basic <encoded-value>'
[
  {
    "id": "aJobDefId",
    "processDefinitionId": "aProcDefId",
    "processDefinitionKey": "aProcDefKey",
    "activityId": "ServiceTask1",
    "jobType": "asynchronous-continuation",
    "jobConfiguration": "",
    "suspended": false,
    "overridingJobPriority": 15,
    "tenantId": null,
    "deploymentId": "aDeploymentId"
  },
  {
    "id": "aJobDefId",
    "processDefinitionId": "aProcDefId",
    "processDefinitionKey": "aProcDefKey",
    "activityId": "ServiceTask2",
    "jobType": "asynchronous-continuation",
    "jobConfiguration": "",
    "suspended": true,
    "overridingJobPriority": null,
    "tenantId": null,
    "deploymentId": "aDeploymentId"
  }
]

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Query Parameters

​
jobDefinitionId
string

Filter by job definition id.

​
activityIdIn
string

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

​
processDefinitionId
string

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

​
processDefinitionKey
string

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

​
jobType
string

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

​
jobConfiguration
string

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

​
active
boolean

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

​
suspended
boolean

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

​
withOverridingJobPriority
boolean

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.

​
tenantIdIn
string

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

​
withoutTenantId
boolean

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

​
includeJobDefinitionsWithoutTenantId
boolean

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
enum<string>

Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter.

Available options:
jobDefinitionId,
activityId,
processDefinitionId,
processDefinitionKey,
jobType,
jobConfiguration,
tenantId
​
sortOrder
enum<string>

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.

Available options:
asc,
desc
​
firstResult
integer

Pagination of results. Specifies the index of the first result to return.

​
maxResults
integer

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.

​
id
string | null

The id of the job definition.

​
processDefinitionId
string | null

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

​
processDefinitionKey
string | null

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

​
activityId
string | null

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

​
jobType
string | null

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

​
jobConfiguration
string | null

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.

​
overridingJobPriority
integer | null

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.

​
suspended
boolean | null

Indicates whether this job definition is suspended or not.

​
tenantId
string | null

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

​
deploymentId
string | null

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.