Skip to main content
GET
/
history
/
cleanup
/
job
Find clean up history job (GET)
curl --request GET \
  --url http://{host}:{port}/{contextPath}/history/cleanup/job \
  --header 'Authorization: Basic <encoded-value>'
{
  "id": "074bd92a-1a95-11e7-8ceb-34f39ab71d4e",
  "jobDefinitionId": null,
  "processInstanceId": null,
  "processDefinitionId": null,
  "processDefinitionKey": null,
  "executionId": null,
  "exceptionMessage": null,
  "retries": 3,
  "dueDate": "2017-04-06T13:57:45.000+0200",
  "suspended": false,
  "priority": 0,
  "tenantId": null,
  "createTime": "2017-05-05T17:00:00+0200"
}

Authorizations

Authorization
string
header
required

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

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<int32> | 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<int64> | 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