Skip to main content
GET
/
job-definition
/
{id}
Get Job Definition
curl --request GET \
  --url http://{host}:{port}/{contextPath}/job-definition/{id} \
  --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"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

The id of the job definition to be retrieved.

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.