Sign in
Historic Batch

Get Cleanable Batch Report

Retrieves a report about a historic batch operations relevant to history cleanup (see History cleanup ) so that you can tune the history time to live. These reports include the count of the finished batches, cleanable batches and type of the batch. The size of the result set can be retrieved by using the Get Cleanable Batch Report Count method.

Please note: The history time to live for batch operations does not support Multi-Tenancy. The report will return an information for all batch operations (for all tenants) if you have permissions to see the history.

get/history/batch/cleanable-batch-report

Request

  • Base URL: http://localhost:8080/engine-rest
  • URL: http://localhost:8080/engine-rest/history/batch/cleanable-batch-report
  • Auth: HTTP basic

Query parameters

sortBy'finished'

Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter.

sortOrder'asc' | 'desc'

Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter.

firstResultinteger

Pagination of results. Specifies the index of the first result to return.

maxResultsinteger

Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left.

Response

Request successful.

batchTypestring nullable

The type of the batch operation.

historyTimeToLiveinteger nullable

The history time to live of the batch operation.

finishedBatchesCountinteger nullable

The count of the finished batch operations.

cleanableBatchesCountinteger nullable

The count of the cleanable historic batch operations, referring to history time to live.

Changes

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