Skip to main content
GET
/
history
/
decision-instance
/
{id}
Get Historic Decision Instance
curl --request GET \
  --url http://{host}:{port}/{contextPath}/history/decision-instance/{id} \
  --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.

Path Parameters

id
string
required

The id of the historic decision instance to be retrieved.

Query Parameters

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.

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.