Retrieves a job definition by id, according to the JobDefinition interface in the engine.

Method

GET /job-definition/{id}

Parameters

Path Parameters

Name	Description
id	The id of the job definition to be retrieved.

Result

A JSON object corresponding to the JobDefinition interface in the engine. Its properties are as follows:

Name	Type	Description
id	String	The id of the job definition.
processDefinitionId	String	The id of the process definition this job definition is associated with.
processDefinitionKey	String	The key of the process definition this job definition is associated with.
activityId	String	The id of the activity this job definition is associated with.
jobType	String	The type of the job which is running for this job definition. See the User Guide for more information about job types.
jobConfiguration	String	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	Number	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	Indicates whether this job definition is suspended or not.
tenantId	String	The id of the tenant this job definition is associated with.
deploymentId	String	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.

Response Codes

Code	Media type	Description
200	application/json	Request successful.
404	application/json	Job definition with given id does not exist. See the Introduction for the error response format.

Example

Request

GET /job-definition/aJobDefinitionId

Response

  {
    "id": "aJobDefId",
    "processDefinitionId": "aProcDefId",
    "processDefinitionKey": "aProcDefKey",
    "activityId": "ServiceTask1",
    "jobType": "asynchronous-continuation",
    "jobConfiguration": "",
    "suspended": false,
    "overridingJobPriority": 15,
    "tenantId": null,
    "deploymentId": "aDeploymentId" 
  }