BPM Platform 7.9

Options

Edit on Github

Get Historic Decision Instance

Retrieves a historic decision instance by id, according to the HistoricDecisionInstance interface in the engine.

Method

GET /history/decision-instance/{id}

Parameters

Path Parameters

Name Description
id The id of the historic decision instance to be retrieved.

Query Parameters

Name Description
includeInputs Include input values in the result. Value may only be true, as false is the default behavior.
includeOutputs Include output values in the result. Value may only be true, as false is the default behavior.
disableBinaryFetching Disables fetching of byte array input and output values. Value may only be true, as false is the default behavior.
disableCustomObjectDeserialization Disables deserialization of input and output values that are custom objects. Value may only be true, as false is the default behavior.

Result

A JSON object corresponding to the HistoricDecisionInstance interface in the engine. Its properties are as follows:

Name Value Description
id String The id of the decision instance.
decisionDefinitionId String The id of the decision definition that this decision instance belongs to.
decisionDefinitionKey String The key of the decision definition that this decision instance belongs to.
decisionDefinitionName String The name of the decision definition that this decision instance belongs to.
evaluationTime String The time the instance was evaluated. Default format* yyyy-MM-dd'T'HH:mm:ss.SSSZ.
processDefinitionId String The id of the process definition that this decision instance belongs to.
processDefinitionKey String The key of the process definition that this decision instance belongs to.
processInstanceId String The id of the process instance that this decision instance belongs to.
caseDefinitionId String The id of the case definition that this decision instance belongs to.
caseDefinitionKey String The key of the case definition that this decision instance belongs to.
caseInstanceId String The id of the case instance that this decision instance belongs to.
activityId String The id of the activity that this decision instance belongs to.
activityInstanceId String The id of the activity instance that this decision instance belongs to.
tenantId String The tenant id of the historic decision instance.
userId String The id of the authenticated user that has evaluated this decision instance without a process or case instance.
inputs List of decision inputs The list of decision input values. Only exists if includeInputs was set to true in the query. For the decision input properties see below.
ouputs List of decision outputs The list of decision output values. Only exists if includeOutputs was set to true in the query. For the decision output properties see below.
collectResultValue Double The result of the collect aggregation of the decision result if used. Can be null if no aggregation was used.
rootDecisionInstanceId String The decision instance id of the evaluated root decision. Can be null if this instance is the root decision instance of the evaluation.
decisionRequirementsDefinitionId String The id of the decision requirements definition that this decision instance belongs to.
decisionRequirementsDefinitionKey String The key of the decision requirements definition that this decision instance belongs to.

* For further information, please see the documentation.

Decision Input Value

Name Value Description
id String The id of the decision input value.
decisionInstanceId String The id of the decision instance the input value belongs to.
clauseId String The id of the clause the input value belongs to.
clauseName String The name of the clause the input value belongs to.
errorMessage String An error message in case a Java Serialized Object could not be de-serialized.
type String The value type of the variable.
value String/Number/Boolean/Object The variable's value. Value differs depending on the variable's type and on the disableCustomObjectDeserialization parameter.
valueInfo Object A JSON object containing additional, value-type-dependent properties.

For variables of type Object, the following properties are returned:

  • objectTypeName: A string representation of the object's type name.
  • serializationDataFormat: The serialization format used to store the variable.

Decision Output Value

Name Value Description
id String The id of the decision output value.
decisionInstanceId String The id of the decision instance the output value belongs to.
clauseId String The id of the clause the output value belongs to.
clauseName String The name of the clause the output value belongs to.
ruleId String The id of the rule the output value belongs to.
ruleOrder Integer The order of the rule the output value belongs to.
errorMessage String An error message in case a Java Serialized Object could not be de-serialized.
variableName String The name of the output variable.
type String The value type of the variable.
value String/Number/Boolean/Object The variable's value. Value differs depending on the variable's type and on the disableCustomObjectDeserialization parameter.
valueInfo Object A JSON object containing additional, value-type-dependent properties.

For variables of type Object, the following properties are returned:

  • objectTypeName: A string representation of the object's type name.
  • serializationDataFormat: The serialization format used to store the variable.

Response Codes

Code Media type Description
200 application/json Request successful.
404 application/json Historic decision instance with given id does not exist. See the Introduction for the error response format.

Example

Request

GET /history/decision-instance/aDecisionInstId?includeInput=true&includeOutputs=true

Response

{
    "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",
    "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",
            "value": 123.0,
            "valueInfo": {}
        },
        {
            "clauseId": "clause2",
            "clauseName": "Invoice Category",
            "decisionInstanceId": "67ea2c3f-579d-11e5-9848-f0def1e59da8",
            "errorMessage": null,
            "id": "67ea2c40-579d-11e5-9848-f0def1e59da8",
            "type": "String",
            "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",
            "value": "accounting",
            "valueInfo": {},
            "variableName": "result"
        }
    ],
    "processDefinitionId": "invoice:1:4c6e3197-579d-11e5-9848-f0def1e59da8",
    "processDefinitionKey": "invoice",
    "processInstanceId": "67e98fec-579d-11e5-9848-f0def1e59da8",
    "caseDefinitionId": null,
    "caseDefinitionKey": null,
    "caseInstanceId": null,
    "tenantId": null,
    "userId": null,
    "rootDecisionInstanceId": null,
    "decisionRequirementsDefinitionId": null,
    "decisionRequirementsDefinitionKey": null
}

On this Page: