Clean up history (POST)

Schedules asynchronous history cleanup (See [History cleanup]/manual/7.7/user-guide/process-engine/history/#history-cleanup).

Method

POST /history/cleanup

Parameters

Query Parameters

Name Description
executeAtOnce 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`.

Request Body

Not used

Result

A JSON object representing scheduled job. See Get Job for the structure and example.

Response Codes

Code Media type Description
200 application/json Request successful.
400 application/json Returned if some of the query parameters are invalid.

Example

Request

POST /history/cleanup

Response

{
    "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",
    "suspended":false,
    "priority":0,
    "tenantId":null
}

On this Page: