History Cleanup

Get History Cleanup Configuration

Retrieves history cleanup batch window configuration (See History cleanup).

get/history/cleanup/configuration

Request

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

Response

Request successful.

batchWindowStartTimestring date-time nullable

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.

batchWindowEndTimestring date-time nullable

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.

enabledboolean nullable

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.

Changes

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