Sign in
History Cleanup

Clean up history (POST)

Schedules asynchronous history cleanup (See History cleanup).

Note: This endpoint will return at most a single history cleanup job. Since version 7.9.0 it is possible to configure multiple parallel history cleanup jobs. Use GET /history/cleanup/jobs to find all the available history cleanup jobs.

post/history/cleanup

Request

  • Base URL: http://localhost:8080/engine-rest
  • URL: http://localhost:8080/engine-rest/history/cleanup
  • Auth: HTTP basic

Query parameters

immediatelyDueboolean

When true the job will be scheduled for nearest future. When false, the job will be scheduled for next batch window start time. Default is true.

Response

Request successful.

idstring nullable

The id of the job.

jobDefinitionIdstring nullable

The id of the associated job definition.

dueDatestring date-time nullable

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

processInstanceIdstring nullable

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

executionIdstring nullable

The specific execution id on which the job was created.

processDefinitionIdstring nullable

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

processDefinitionKeystring nullable

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

retriesinteger nullable

The number of retries this job has left.

exceptionMessagestring nullable

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

failedActivityIdstring nullable

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

suspendedboolean nullable

A flag indicating whether the job is suspended or not.

priorityinteger nullable

The job's priority for execution.

tenantIdstring nullable

The id of the tenant which this job belongs to.

createTimestring date-time nullable

The date on which this job has been created.

batchIdstring nullable

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

Changes

No recorded changes to this operation across all 1 revision of this API.