Historic Decision Instance

Get Historic Decision Instances

Queries for historic decision instances that fulfill the given parameters. The size of the result set can be retrieved by using the Get Historic Decision Instance Count method.

get/history/decision-instance

Request

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

Query parameters

decisionInstanceIdstring

Filter by decision instance id.

decisionInstanceIdInstring

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

decisionDefinitionIdstring

Filter by the decision definition the instances belongs to.

decisionDefinitionIdInstring

Filter by the decision definitions the instances belongs to. Must be a comma-separated list of decision definition ids.

decisionDefinitionKeystring

Filter by the key of the decision definition the instances belongs to.

decisionDefinitionKeyInstring

Filter by the keys of the decision definition the instances belongs to. Must be a comma- separated list of decision definition keys.

decisionDefinitionNamestring

Filter by the name of the decision definition the instances belongs to.

decisionDefinitionNameLikestring

Filter by the name of the decision definition the instances belongs to, that the parameter is a substring of.

processDefinitionIdstring

Filter by the process definition the instances belongs to.

processDefinitionKeystring

Filter by the key of the process definition the instances belongs to.

processInstanceIdstring

Filter by the process instance the instances belongs to.

caseDefinitionIdstring

Filter by the case definition the instances belongs to.

caseDefinitionKeystring

Filter by the key of the case definition the instances belongs to.

caseInstanceIdstring

Filter by the case instance the instances belongs to.

activityIdInstring

Filter by the activity ids the instances belongs to. Must be a comma-separated list of acitvity ids.

activityInstanceIdInstring

Filter by the activity instance ids the instances belongs to. Must be a comma-separated list of acitvity instance ids.

tenantIdInstring

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

withoutTenantIdboolean

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

evaluatedBeforestring date-time

Restrict to instances that were evaluated before the given date. 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.

evaluatedAfterstring date-time

Restrict to instances that were evaluated after the given date. 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.

userIdstring

Restrict to instances that were evaluated by the given user.

rootDecisionInstanceIdstring

Restrict to instances that have a given root decision instance id. This also includes the decision instance with the given id.

rootDecisionInstancesOnlyboolean

Restrict to instances those are the root decision instance of an evaluation. Value may only be true, as false is the default behavior.

decisionRequirementsDefinitionIdstring

Filter by the decision requirements definition the instances belongs to.

decisionRequirementsDefinitionKeystring

Filter by the key of the decision requirements definition the instances belongs to.

includeInputsboolean

Include input values in the result. Value may only be true, as false is the default behavior.

includeOutputsboolean

Include output values in the result. Value may only be true, as false is the default behavior.

disableBinaryFetchingboolean

Disables fetching of byte array input and output values. Value may only be true, as false is the default behavior.

disableCustomObjectDeserializationboolean

Disables deserialization of input and output values that are custom objects. Value may only be true, as false is the default behavior.

sortBy'evaluationTime' | 'tenantId'

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.

idstring nullable

The id of the decision instance.

decisionDefinitionIdstring nullable

The id of the decision definition that this decision instance belongs to.

decisionDefinitionKeystring nullable

The key of the decision definition that this decision instance belongs to.

decisionDefinitionNamestring nullable

The name of the decision definition that this decision instance belongs to.

evaluationTimestring date-time nullable

The time the instance was evaluated. Default format yyyy-MM-dd'T'HH:mm:ss.SSSZ.

removalTimestring date-time nullable

The time after which the instance should be removed by the History Cleanup job. Default format yyyy-MM-dd'T'HH:mm:ss.SSSZ.

processDefinitionIdstring nullable

The id of the process definition that this decision instance belongs to.

processDefinitionKeystring nullable

The key of the process definition that this decision instance belongs to.

processInstanceIdstring nullable

The id of the process instance that this decision instance belongs to.

caseDefinitionIdstring nullable

The id of the case definition that this decision instance belongs to.

caseDefinitionKeystring nullable

The key of the case definition that this decision instance belongs to.

caseInstanceIdstring nullable

The id of the case instance that this decision instance belongs to.

activityIdstring nullable

The id of the activity that this decision instance belongs to.

activityInstanceIdstring nullable

The id of the activity instance that this decision instance belongs to.

tenantIdstring nullable

The tenant id of the historic decision instance.

userIdstring nullable

The id of the authenticated user that has evaluated this decision instance without a process or case instance.

collectResultValuenumber double nullable

The result of the collect aggregation of the decision result if used. null if no aggregation was used.

rootDecisionInstanceIdstring nullable

The decision instance id of the evaluated root decision. Can be null if this instance is the root decision instance of the evaluation.

rootProcessInstanceIdstring nullable

The process instance id of the root process instance that initiated the evaluation of this decision. Can be null if this decision instance is not evaluated as part of a BPMN process.

decisionRequirementsDefinitionIdstring nullable

The id of the decision requirements definition that this decision instance belongs to.

decisionRequirementsDefinitionKeystring nullable

The key of the decision requirements definition that this decision instance belongs to.

Changes

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