Skip to main content
GET
/
job
/
{id}
Get Job
curl --request GET \
  --url http://{host}:{port}/{contextPath}/job/{id} \
  --header 'Authorization: Basic <encoded-value>'
{
  "id": "aJobId",
  "jobDefinitionId": "f9eec330-e3ff-11e8-8f7d-e4a7a094a9d6",
  "dueDate": "2018-07-17T17:00:00+0200",
  "processInstanceId": "aProcessInstanceId",
  "processDefinitionId": "timer:1:f9ee9c1f-e3ff-11e8-8f7d-e4a7a094a9d6",
  "processDefinitionKey": "timer",
  "executionId": "anExecutionId",
  "retries": 0,
  "exceptionMessage": "An exception Message",
  "failedActivityId": "anActivityId",
  "suspended": false,
  "priority": 10,
  "tenantId": null,
  "createTime": "2018-05-05T17:00:00+0200",
  "batchId": "aBatchId"
}

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 to be retrieved.

Response

Request successful.

​
id
string | null

The id of the job.

​
jobDefinitionId
string | null

The id of the associated job definition.

​
dueDate
string<date-time> | null

The date on which this job is supposed to be processed.

​
processInstanceId
string | null

The id of the process instance which execution created the job.

​
executionId
string | null

The specific execution id on which the job was created.

​
processDefinitionId
string | null

The id of the process definition which this job belongs to.

​
processDefinitionKey
string | null

The key of the process definition which this job belongs to.

​
retries
integer | null

The number of retries this job has left.

​
exceptionMessage
string | null

The message of the exception that occurred, the last time the job was executed. Is null when no exception occurred.

​
failedActivityId
string | null

The id of the activity on which the last exception occurred, the last time the job was executed. Is null when no exception occurred.

​
suspended
boolean | null

A flag indicating whether the job is suspended or not.

​
priority
integer | null

The job's priority for execution.

​
tenantId
string | null

The id of the tenant which this job belongs to.

​
createTime
string<date-time> | null

The date on which this job has been created.

​
batchId
string | null

The ID of the batch associated with this job. null if no batch is associated with this job. The following jobs are associated with batches:

  • Seed Jobs
  • Monitor Jobs
  • Batch Execution Jobs