Skip to main content
GET
/
history
/
cleanup
/
configuration
Get History Cleanup Configuration
curl --request GET \
  --url http://{host}:{port}/{contextPath}/history/cleanup/configuration \
  --header 'Authorization: Basic <encoded-value>'
{
  "batchWindowStartTime": "2017-09-11T23:59:00.000+0200",
  "batchWindowEndTime": "2017-09-12T02:00:00.000+0200",
  "enabled": "true"
}

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

200 - application/json

Request successful.

​
batchWindowStartTime
string<date-time> | null

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
string<date-time> | null

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 | null

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.