Sign in
Historic Decision Definition

Get Cleanable Decision Instance Report

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

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

Request

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

Query parameters

decisionDefinitionIdInstring

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

decisionDefinitionKeyInstring

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

tenantIdInstring

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

withoutTenantIdboolean

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

compactboolean

Only include decision 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.

decisionDefinitionIdstring nullable

The id of the decision definition.

decisionDefinitionKeystring nullable

The key of the decision definition.

decisionDefinitionNamestring nullable

The name of the decision definition.

decisionDefinitionVersioninteger nullable

The version of the decision definition.

historyTimeToLiveinteger nullable

The history time to live of the decision definition.

finishedDecisionInstanceCountinteger nullable

The count of the finished historic decision instances.

cleanableDecisionInstanceCountinteger nullable

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

tenantIdstring nullable

The tenant id of the decision definition.

Changes

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