Query decision instances

POST 
/decision-instances/search

Search for decision instances based on given criteria.

Request

application/json

Body

sort object[]
Sort field criteria.
Array [
field stringrequired
The field to sort by.
order SortOrderEnum
Possible values: [ASC, DESC]
Default value: ASC
The order in which to sort the related field.
]
page object

Pagination criteria.

from int32

The index of items to start searching from.

limit int32

The maximum number of items to return in one request.

searchAfter object[]

Items to search after. Correlates to the lastSortValues property of a previous search response.

searchBefore object[]

Items to search before. Correlates to the firstSortValues property of a previous search response.

filter object

Decision instance search filter.

decisionInstanceKey int64

The key of the decision instance. Note that this is not the unique identifier of the entity itself; the decisionInstanceId serves as the primary identifier.

decisionInstanceId string

The ID 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 object

The evaluation date of the decision instance.

oneOf

MOD1

string

AdvancedDateTimeFilter

$eq date-time

Checks for equality with the provided value.

$neq date-time

Checks for inequality with the provided value.

$exists boolean

Checks if the current property exists.

$gt date-time

Greater than comparison with the provided value.

$gte date-time

Greater than or equal comparison with the provided value.

$lt date-time

Lower than comparison with the provided value.

$lte date-time

Lower than or equal comparison with the provided value.

$in date-time[]

Checks if the property matches any of the provided values.

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

Pagination information about the search results.

totalItems int64

Total items matching the criteria.

firstSortValues object[]

The sort values of the first item in the result set. Use this in the searchBefore field of an ensuing request.

lastSortValues object[]

The sort values of the last item in the result set. Use this in the searchAfter field of an ensuing request.

items object[]
The matching decision instances.
Array [
decisionInstanceKey int64
The key of the decision instance. Note that this is not the unique identifier of the entity itself; the decisionInstanceId serves as the primary identifier.
decisionInstanceId string
The ID 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,
      "decisionInstanceId": "string",
      "evaluationDate": "2024-12-13T13:19:42.565Z",
      "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"
}

401

The request lacks valid authentication credentials.

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"
}

403

Forbidden. The request is not allowed.

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