Skip to main content
Version: Next

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

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

    tenantId string

    The tenant ID of the decision instance.

Responses

The decision instance search result.

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.

  • ]
Loading...