Skip to main content
Version: Next

Get decision instance (alpha)

GET 

/decision-instances/:decisionInstanceKey

Returns a decision instance.

Note that this endpoint is an alpha feature and not enabled on Camunda clusters out of the box. The Camunda 8 API (REST) Overview page provides further details.

note

This endpoint is an alpha feature and may be subject to change in future releases.

Request

Path Parameters

    decisionInstanceKey int64required

    The assigned key of the decision instance, which acts as a unique identifier for this decision instance.

Responses

The decision instance is successfully returned.

Schema
    decisionInstanceKey int64

    The key of the decision instance.

    state DecisionInstanceStateEnum

    Possible values: [EVALUATED, FAILED, UNSPECIFIED, UNKNOWN]

    The state of the decision instance.

    evaluationDate date-time

    The evaluation date of the decision instance.

    evaluationFailure string

    The evaluation failure of the decision instance.

    processDefinitionKey int64

    The key of the process definition.

    processInstanceKey int64

    The key of the process instance.

    decisionDefinitionKey int64

    The key of the decision.

    decisionDefinitionId string

    The ID of the DMN decision.

    decisionDefinitionName string

    The name of the DMN decision.

    decisionDefinitionVersion int32

    The version of the decision.

    decisionDefinitionType DecisionDefinitionTypeEnum

    Possible values: [DECISION_TABLE, LITERAL_EXPRESSION, UNSPECIFIED, UNKNOWN]

    The type of the decision.

    result string

    The result of the decision instance.

    tenantId string

    The tenant ID of the decision instance.

    evaluatedInputs object[]

    The evaluated inputs of the decision instance.

  • Array [
  • inputId string

    The ID of the evaluated decision input.

    inputName string

    The name of the evaluated decision input.

    inputValue string

    The value of the evaluated decision input.

  • ]
  • matchedRules object[]

    The matched rules of the decision instance.

  • Array [
  • ruleId string

    The ID of the matched rule.

    ruleIndex int32

    The index of the matched rule.

    evaluatedOutputs object[]
  • Array [
  • outputId string

    The ID of the evaluated decision output.

    outputName string

    The name of the evaluated decision output.

    outputValue string

    The value of the evaluated decision output.

  • ]
  • ]
Loading...