Sign in
Historic Process Definition

Get Cleanable Process Instance Report

Retrieves a report about a process definition and finished process instances 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 historic process instances, cleanable process instances and basic process definition data - id, key, name and version. The size of the result set can be retrieved by using the Get Cleanable Process Instance Report Count method.

get/history/process-definition/cleanable-process-instance-report

Request

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

Query parameters

processDefinitionIdInstring

Filter by process definition ids. Must be a comma-separated list of process definition ids.

processDefinitionKeyInstring

Filter by process definition keys. Must be a comma-separated list of process definition keys.

tenantIdInstring

Filter by a comma-separated list of tenant ids. A process definition must have one of the given tenant ids.

withoutTenantIdboolean

Only include process definitions which belong to no tenant. Value may only be true, as false is the default behavior.

compactboolean

Only include process instances which have more than zero finished instances. Value may only be true, as false is the default behavior.

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.

processDefinitionIdstring nullable

The id of the process definition.

processDefinitionKeystring nullable

The key of the process definition.

processDefinitionNamestring nullable

The name of the process definition.

processDefinitionVersioninteger nullable

The version of the process definition.

historyTimeToLiveinteger nullable

The history time to live of the process definition.

finishedProcessInstanceCountinteger nullable

The count of the finished historic process instances.

cleanableProcessInstanceCountinteger nullable

The count of the cleanable historic process instances, referring to history time to live.

tenantIdstring nullable

The tenant id of the process definition.

Changes

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