Query decision instances (alpha)

POST 
/decision-instances/search

Search for decision instances based on given criteria.

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

application/json

Body

sort object[]
Array [
field stringrequired
order string
Default value: asc
]
page object
from int32
limit int32
searchAfter object[]
searchBefore object[]
filter object

decisionInstanceKey int64

The key of the decision instance.

state DecisionInstanceStateEnum

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

The state of the decision instance.

evaluationFailure string

The evaluation failure of the decision instance.

evaluationDate date-time

The evaluation date of the decision instance.

processDefinitionKey int64

The key of the process definition.

processInstanceKey int64

The key of the process instance.

decisionDefinitionKey object

The key of the decision.

oneOf

MOD1

integer

BasicLongFilter

$eq int64

Checks for equality with the provided value.

$neq int64

Checks for inequality with the provided value.

$exists boolean

Checks if the current property exists.

$in int64[]

Checks if the property matches any of the provided values.

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.

tenantId string

The tenant ID of the decision instance.

Responses

200

The decision instance search result.

application/json

Schema

Schema

page object
totalItems int64
firstSortValues object[]
lastSortValues object[]
items object[]
Array [
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.
]

Example (from schema)

{
  "items": [
    {
      "decisionInstanceKey": 0,
      "evaluationDate": "2024-11-14T15:06:47.133Z",
      "evaluationFailure": "string",
      "processDefinitionKey": 0,
      "processInstanceKey": 0,
      "decisionDefinitionKey": 0,
      "decisionDefinitionId": "string",
      "decisionDefinitionName": "string",
      "decisionDefinitionVersion": 0,
      "result": "string",
      "tenantId": "string"
    }
  ],
  "page": {
    "totalItems": 0,
    "firstSortValues": [
      {}
    ],
    "lastSortValues": [
      {}
    ]
  }
}

400

The decision instance search query 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"
}

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