Skip to main content
GET
/
history
/
decision-instance
Get Historic Decision Instances
curl --request GET \
  --url http://{host}:{port}/{contextPath}/history/decision-instance \
  --header 'Authorization: Basic <encoded-value>'
[
  {
    "activityId": "assignApprover",
    "activityInstanceId": "assignApprover:67e9de1e-579d-11e5-9848-f0def1e59da8",
    "collectResultValue": null,
    "decisionDefinitionId": "invoice-assign-approver:1:4c864d79-579d-11e5-9848-f0def1e59da8",
    "decisionDefinitionKey": "invoice-assign-approver",
    "decisionDefinitionName": "Assign Approver",
    "evaluationTime": "2015-09-10T11:22:06.000+0200",
    "removalTime": null,
    "id": "67ea2c3f-579d-11e5-9848-f0def1e59da8",
    "inputs": [
      {
        "clauseId": "clause1",
        "clauseName": "Invoice Amount",
        "decisionInstanceId": "67ea2c3f-579d-11e5-9848-f0def1e59da8",
        "errorMessage": null,
        "id": "67ea2c41-579d-11e5-9848-f0def1e59da8",
        "type": "Double",
        "createTime": "2015-09-10T11:22:06.000+0200",
        "removalTime": null,
        "rootProcessInstanceId": "aRootProcessInstanceId",
        "value": 123,
        "valueInfo": {}
      },
      {
        "clauseId": "clause2",
        "clauseName": "Invoice Category",
        "decisionInstanceId": "67ea2c3f-579d-11e5-9848-f0def1e59da8",
        "errorMessage": null,
        "id": "67ea2c40-579d-11e5-9848-f0def1e59da8",
        "type": "String",
        "createTime": "2015-09-10T11:22:06.000+0200",
        "removalTime": null,
        "rootProcessInstanceId": "aRootProcessInstanceId",
        "value": "Misc",
        "valueInfo": {}
      }
    ],
    "outputs": [
      {
        "clauseId": "clause3",
        "clauseName": "Approver Group",
        "decisionInstanceId": "67ea2c3f-579d-11e5-9848-f0def1e59da8",
        "errorMessage": null,
        "id": "67ea2c42-579d-11e5-9848-f0def1e59da8",
        "ruleId": "DecisionRule_1of5a87",
        "ruleOrder": 1,
        "type": "String",
        "createTime": "2015-09-10T11:22:06.000+0200",
        "removalTime": null,
        "rootProcessInstanceId": "aRootProcessInstanceId",
        "value": "accounting",
        "valueInfo": {},
        "variableName": "result"
      }
    ],
    "processDefinitionId": "invoice:1:4c6e3197-579d-11e5-9848-f0def1e59da8",
    "processDefinitionKey": "invoice",
    "processInstanceId": "67e98fec-579d-11e5-9848-f0def1e59da8",
    "rootProcessInstanceId": "f8259e5d-ab9d-11e8-8449-e4a7a094a9d6",
    "caseDefinitionId": null,
    "caseDefinitionKey": null,
    "caseInstanceId": null,
    "tenantId": null,
    "userId": null,
    "rootDecisionInstanceId": null,
    "decisionRequirementsDefinitionId": null,
    "decisionRequirementsDefinitionKey": null
  }
]

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Query Parameters

decisionInstanceId
string

Filter by decision instance id.

decisionInstanceIdIn
string

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

decisionDefinitionId
string

Filter by the decision definition the instances belongs to.

decisionDefinitionIdIn
string

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

decisionDefinitionKey
string

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

decisionDefinitionKeyIn
string

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

decisionDefinitionName
string

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

decisionDefinitionNameLike
string

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

processDefinitionId
string

Filter by the process definition the instances belongs to.

processDefinitionKey
string

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

processInstanceId
string

Filter by the process instance the instances belongs to.

caseDefinitionId
string

Filter by the case definition the instances belongs to.

caseDefinitionKey
string

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

caseInstanceId
string

Filter by the case instance the instances belongs to.

activityIdIn
string

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

activityInstanceIdIn
string

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

tenantIdIn
string

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

withoutTenantId
boolean

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

evaluatedBefore
string<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.

evaluatedAfter
string<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.

userId
string

Restrict to instances that were evaluated by the given user.

rootDecisionInstanceId
string

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

rootDecisionInstancesOnly
boolean

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

decisionRequirementsDefinitionId
string

Filter by the decision requirements definition the instances belongs to.

decisionRequirementsDefinitionKey
string

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

includeInputs
boolean

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

includeOutputs
boolean

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

disableBinaryFetching
boolean

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

disableCustomObjectDeserialization
boolean

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

sortBy
enum<string>

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

Available options:
evaluationTime,
tenantId
sortOrder
enum<string>

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.

Available options:
asc,
desc
firstResult
integer

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

maxResults
integer

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.

id
string | null

The id of the decision instance.

decisionDefinitionId
string | null

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

decisionDefinitionKey
string | null

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

decisionDefinitionName
string | null

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

evaluationTime
string<date-time> | null

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

removalTime
string<date-time> | null

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

processDefinitionId
string | null

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

processDefinitionKey
string | null

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

processInstanceId
string | null

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

caseDefinitionId
string | null

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

caseDefinitionKey
string | null

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

caseInstanceId
string | null

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

activityId
string | null

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

activityInstanceId
string | null

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

tenantId
string | null

The tenant id of the historic decision instance.

userId
string | null

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

inputs
object[] | null

The list of decision input values. Only exists if includeInputs was set to true in the query.

outputs
object[] | null

The list of decision output values. Only exists if includeOutputs was set to true in the query.

collectResultValue
number | null

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

rootDecisionInstanceId
string | null

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

rootProcessInstanceId
string | null

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.

decisionRequirementsDefinitionId
string | null

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

decisionRequirementsDefinitionKey
string | null

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