Get decision instance by key (alpha)

GET 
/decision-instances/:decisionInstanceKey

Returns a decision instance.

note

This endpoint is an alpha feature and not enabled on Camunda clusters out of the box. See the Camunda 8 REST API overview for further details.

Request

Path Parameters

decisionInstanceKey int64required

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

Responses

200

The decision instance is successfully returned.

application/json

Schema

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.
]
]

Example (from schema)

{
  "decisionInstanceKey": 0,
  "evaluationDate": "2024-10-10T15:06:34.494Z",
  "evaluationFailure": "string",
  "processDefinitionKey": 0,
  "processInstanceKey": 0,
  "decisionDefinitionKey": 0,
  "decisionDefinitionId": "string",
  "decisionDefinitionName": "string",
  "decisionDefinitionVersion": 0,
  "result": "string",
  "tenantId": "string",
  "evaluatedInputs": [
    {
      "inputId": "string",
      "inputName": "string",
      "inputValue": "string"
    }
  ],
  "matchedRules": [
    {
      "ruleId": "string",
      "ruleIndex": 0,
      "evaluatedOutputs": [
        {
          "outputId": "string",
          "outputName": "string",
          "outputValue": "string"
        }
      ]
    }
  ]
}

400

The decision instance request failed. More details are provided in the response body.

application/problem+json

Schema

Schema

type uri

Default value: about:blank

A URI identifying the problem type.

title string

A summary of the problem type.

status int32

Possible values: >= 400 and <= 600

The HTTP status code for this problem.

detail string

An explanation of the problem in more detail.

instance uri

A URI identifying the origin of the problem.

Example (from schema)

{
  "type": "about:blank",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

404

The decision instance with the given key was not found. More details are provided in the response body.

application/problem+json

Schema

Schema

type uri

Default value: about:blank

A URI identifying the problem type.

title string

A summary of the problem type.

status int32

Possible values: >= 400 and <= 600

The HTTP status code for this problem.

detail string

An explanation of the problem in more detail.

instance uri

A URI identifying the origin of the problem.

Example (from schema)

{
  "type": "about:blank",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

500

An internal error occurred while processing the request.

application/problem+json

Schema

Schema

type uri

Default value: about:blank

A URI identifying the problem type.

title string

A summary of the problem type.

status int32

Possible values: >= 400 and <= 600

The HTTP status code for this problem.

detail string

An explanation of the problem in more detail.

instance uri

A URI identifying the origin of the problem.

Example (from schema)

{
  "type": "about:blank",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

Loading...