Skip to main content
POST
/
job-definition
Get Job Definitions (POST)
curl --request POST \
  --url http://{host}:{port}/{contextPath}/job-definition \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "activityIdIn": [
    "ServiceTask1",
    "ServiceTask2"
  ],
  "sorting": [
    {
      "sortBy": "activityId",
      "sortOrder": "asc"
    },
    {
      "sortBy": "jobType",
      "sortOrder": "asc"
    }
  ]
}'
[
  {
    "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

​
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.

Body

application/json

A Job definition query which defines a list of Job definitions

​
jobDefinitionId
string | null

Filter by job definition id.

​
activityIdIn
string[] | null

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

​
processDefinitionId
string | null

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

​
processDefinitionKey
string | null

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

​
jobType
string | null

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

​
jobConfiguration
string | null

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

​
active
boolean | null

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

​
suspended
boolean | null

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

​
withOverridingJobPriority
boolean | null

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[] | null

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

​
withoutTenantId
boolean | null

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

​
includeJobDefinitionsWithoutTenantId
boolean | null

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.

​
sorting
object[] | null

An array of criteria to sort the result by. Each element of the array is an object that specifies one ordering. The position in the array identifies the rank of an ordering, i.e., whether it is primary, secondary, etc. Sorting has no effect for count endpoints.

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.