Skip to content

Get one decision of a past evaluation

GET
/v2/decision-instances/{decisionEvaluationInstanceKey}
curl --request GET \
--url http://localhost:8080/v2/decision-instances/2251799813684367-1 \
--header 'Authorization: Bearer <token>'
Available inEmbeddedBundledCluster
AuthAuthenticated Bearer token or console session · requires history:read

One decision instance with what it evaluated: its inputs and the rules that matched, each rule’s outputs. A malformed key is 400; a key the tenant has no decision instance for, or one of a decision the caller may not read, is 404.

decisionEvaluationInstanceKey
required
string
/^[1-9][0-9]*-[1-9][0-9]*$/

<decisionEvaluationKey>-<position>, the position counted from 1.

x-tenant-id
string
>= 1 characters

Tenant selection. A principal bound to one tenant may omit it; if sent, it must equal that tenant (403 otherwise). A principal that may act in several tenants must send it on every request: without it the request is refused with 400, and a tenant it may not act in is refused with 403.

The decision instance.

Media typeapplication/json
object
businessId
required

Part of the wire shape. This release always sends null.

null
decisionDefinitionId
required
string
decisionDefinitionKey
required

Positive signed 64-bit entity key, written as a decimal string.

string
/^[1-9][0-9]*$/
decisionDefinitionName
required

The decision’s name; empty when the model gives none.

string
decisionDefinitionType
required
string
Allowed values: DECISION_TABLE LITERAL_EXPRESSION UNKNOWN
decisionDefinitionVersion
required

The decision’s version; -1 for a required decision that failed before the evaluation described it.

integer format: int32
decisionEvaluationInstanceKey
required
string
/^[1-9][0-9]*-[1-9][0-9]*$/
decisionEvaluationKey
required

Positive signed 64-bit entity key, written as a decimal string.

string
/^[1-9][0-9]*$/
elementInstanceKey
required
Any of:

Positive signed 64-bit entity key, written as a decimal string.

string
/^[1-9][0-9]*$/
evaluationDate
required

An RFC 3339 timestamp.

string format: date-time
evaluationFailure
required

Why the evaluation failed

string | null
processDefinitionKey
required
Any of:

Positive signed 64-bit entity key, written as a decimal string.

string
/^[1-9][0-9]*$/
processInstanceKey
required
Any of:

Positive signed 64-bit entity key, written as a decimal string.

string
/^[1-9][0-9]*$/
result
required

The decision’s output as JSON text (null for a decision that failed).

string
rootDecisionDefinitionKey
required

Positive signed 64-bit entity key, written as a decimal string.

string
/^[1-9][0-9]*$/
rootProcessInstanceKey
required
Any of:

Positive signed 64-bit entity key, written as a decimal string.

string
/^[1-9][0-9]*$/
state
required
string
Allowed values: EVALUATED FAILED
tenantId
required
string
evaluatedInputs
required

The decision table’s inputs as they were evaluated (none for a literal expression).

Array<object>
object
inputId
required
string
inputName
required
string
inputValue
required

JSON text.

string
matchedRules
required
Array<object>
object
ruleId
required
string
ruleIndex
required

From 1.

integer format: int32
evaluatedOutputs
required
Array<object>
object
outputId
required
string
outputName
required
string
outputValue
required

JSON text.

string
ruleId
required
string
ruleIndex
required
integer format: int32
Example
{
"decisionDefinitionKey": "2251799813685249",
"decisionDefinitionType": "DECISION_TABLE",
"decisionEvaluationKey": "2251799813685249",
"elementInstanceKey": "2251799813685249",
"processDefinitionKey": "2251799813685249",
"processInstanceKey": "2251799813685249",
"rootDecisionDefinitionKey": "2251799813685249",
"rootProcessInstanceKey": "2251799813685249",
"state": "EVALUATED"
}

The request is malformed, or it uses a property or filter this release does not support.

Media typeapplication/problem+json

An RFC 9457 problem document. type is a stable TinyConductor URN.

object
type
required
string
/^urn:bpm:error:/
title
required
string
status
required
integer
>= 400 <= 599
detail
required
string
instance
required

The request path.

string
mode

Present only on mode-not-supported. It names the engine’s mode.

string
Example
{
"type": "urn:bpm:error:invalid-argument",
"title": "Bad Request",
"status": 400,
"detail": "entity key must be a positive int64 string",
"instance": "/v2/process-instances/0"
}

No valid credential was presented.

Media typeapplication/problem+json

An RFC 9457 problem document. type is a stable TinyConductor URN.

object
type
required
string
/^urn:bpm:error:/
title
required
string
status
required
integer
>= 400 <= 599
detail
required
string
instance
required

The request path.

string
mode

Present only on mode-not-supported. It names the engine’s mode.

string
Example
{
"type": "urn:bpm:error:unauthorized",
"title": "Unauthorized",
"status": 401,
"detail": "A valid bearer credential is required",
"instance": "/v2/decision-instances/2251799813685262"
}
WWW-Authenticate
string
Allowed value: Bearer

The caller lacks the required permission, a tenant named in the request is not the caller’s tenant, or a cookie write has no valid CSRF token.

Media typeapplication/problem+json

An RFC 9457 problem document. type is a stable TinyConductor URN.

object
type
required
string
/^urn:bpm:error:/
title
required
string
status
required
integer
>= 400 <= 599
detail
required
string
instance
required

The request path.

string
mode

Present only on mode-not-supported. It names the engine’s mode.

string
Example
{
"type": "urn:bpm:error:forbidden",
"title": "Forbidden",
"status": 403,
"detail": "The principal lacks the action this route requires",
"instance": "/v2/decision-instances/2251799813685262"
}

The entity does not exist in the caller’s tenant.

Media typeapplication/problem+json

An RFC 9457 problem document. type is a stable TinyConductor URN.

object
type
required
string
/^urn:bpm:error:/
title
required
string
status
required
integer
>= 400 <= 599
detail
required
string
instance
required

The request path.

string
mode

Present only on mode-not-supported. It names the engine’s mode.

string
Example
{
"type": "urn:bpm:error:not-found",
"title": "Not Found",
"status": 404,
"detail": "The requested resource does not exist",
"instance": "/v2/decision-instances/2251799813685262"
}

An internal failure. The details are never exposed.

Media typeapplication/problem+json

An RFC 9457 problem document. type is a stable TinyConductor URN.

object
type
required
string
/^urn:bpm:error:/
title
required
string
status
required
integer
>= 400 <= 599
detail
required
string
instance
required

The request path.

string
mode

Present only on mode-not-supported. It names the engine’s mode.

string
Example
{
"type": "urn:bpm:error:internal",
"title": "Internal Server Error",
"status": 500,
"detail": "The request could not be completed",
"instance": "/v2/decision-instances/2251799813685262"
}

The operation is not offered in the engine’s current deployment mode.

Media typeapplication/problem+json

An RFC 9457 problem document. type is a stable TinyConductor URN.

object
type
required
string
/^urn:bpm:error:/
title
required
string
status
required
integer
>= 400 <= 599
detail
required
string
instance
required

The request path.

string
mode

Present only on mode-not-supported. It names the engine’s mode.

string
Example
{
"type": "urn:bpm:error:mode-not-supported",
"title": "Mode Not Supported",
"status": 501,
"detail": "/v2/clock is not supported in bundled mode: the deterministic virtual clock and the storage-free reset exist only for the Embedded engine; Bundled and Cluster run on the system clock over durable history, which cannot be pinned, rewound or discarded",
"instance": "/v2/clock",
"mode": "bundled"
}

Backpressure, or a dependency is not ready. Retry with the same idempotency key.

Media typeapplication/problem+json

An RFC 9457 problem document. type is a stable TinyConductor URN.

object
type
required
string
/^urn:bpm:error:/
title
required
string
status
required
integer
>= 400 <= 599
detail
required
string
instance
required

The request path.

string
mode

Present only on mode-not-supported. It names the engine’s mode.

string
Example
{
"type": "urn:bpm:error:unavailable",
"title": "Service Unavailable",
"status": 503,
"detail": "The required engine service is not ready",
"instance": "/v2/decision-instances/2251799813685262"
}