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.
This endpoint is an alpha feature and may be subject to change in future releases.
Request
Path Parameters
The assigned key of the decision instance, which acts as a unique identifier for this decision instance.
Responses
- 200
- 400
- 404
- 500
The decision instance is successfully returned.
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
- Array [
- Array [
- ]
- ]
The key of the decision instance.
Possible values: [EVALUATED
, FAILED
, UNSPECIFIED
, UNKNOWN
]
The state of the decision instance.
The evaluation date of the decision instance.
The evaluation failure of the decision instance.
The key of the process definition.
The key of the process instance.
The key of the decision.
The ID of the DMN decision.
The name of the DMN decision.
The version of the decision.
Possible values: [DECISION_TABLE
, LITERAL_EXPRESSION
, UNSPECIFIED
, UNKNOWN
]
The type of the decision.
The result of the decision instance.
The tenant ID of the decision instance.
evaluatedInputs object[]
The evaluated inputs of the decision instance.
The ID of the evaluated decision input.
The name of the evaluated decision input.
The value of the evaluated decision input.
matchedRules object[]
The matched rules of the decision instance.
The ID of the matched rule.
The index of the matched rule.
evaluatedOutputs object[]
The ID of the evaluated decision output.
The name of the evaluated decision output.
The value of the evaluated decision output.
{
"decisionInstanceKey": 0,
"evaluationDate": "2024-11-07T21:11:50.854Z",
"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"
}
]
}
]
}
The decision instance request failed. More details are provided in the response body.
- application/problem+json
- Schema
- Example (from schema)
Schema
Default value: about:blank
A URI identifying the problem type.
A summary of the problem type.
Possible values: >= 400
and <= 600
The HTTP status code for this problem.
An explanation of the problem in more detail.
A URI identifying the origin of the problem.
{
"type": "about:blank",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string"
}
The decision instance with the given key was not found. More details are provided in the response body.
- application/problem+json
- Schema
- Example (from schema)
Schema
Default value: about:blank
A URI identifying the problem type.
A summary of the problem type.
Possible values: >= 400
and <= 600
The HTTP status code for this problem.
An explanation of the problem in more detail.
A URI identifying the origin of the problem.
{
"type": "about:blank",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string"
}
An internal error occurred while processing the request.
- application/problem+json
- Schema
- Example (from schema)
Schema
Default value: about:blank
A URI identifying the problem type.
A summary of the problem type.
Possible values: >= 400
and <= 600
The HTTP status code for this problem.
An explanation of the problem in more detail.
A URI identifying the origin of the problem.
{
"type": "about:blank",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string"
}