Get History Cleanup Configuration
Retrieves history cleanup batch window configuration (See History cleanup).
Method
GET /history/cleanup/configuration
Parameters
Query Parameters
Not used
Request Body
Not used
Result
A JSON object representing batch window datetimes with timezone.
| Name | Value | Description |
|---|---|---|
| batchWindowStartTime | Date | Start time of the current or next batch window. By default,
the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g.,
2013-01-23T14:42:45.000+0200.
|
| batchWindowEndTime | Date | End time of the current or next batch window. By default,
the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g.,
2013-01-23T14:42:45.000+0200.
|
| enabled | Boolean |
Indicates whether the engine node participates in history cleanup or not. The default is true. Participation can be disabled via Process Engine Configuration.For more details, see Cleanup Execution Participation per Node. |
Response Codes
| Code | Media type | Description |
|---|---|---|
| 200 | application/json | Request successful. |
Example
Request
GET /history/cleanup/configuration
Response
{
"batchWindowStartTime":"2017-09-11T23:59:00.000+0200",
"batchWindowEndTime":"2017-09-12T02:00:00.000+0200",
"enabled":"true"
}