Query decision definitions (alpha)

POST 
/decision-definitions/search

Search for decision definitions based on given criteria.

note

This endpoint is an alpha feature and not enabled on Camunda clusters out of the box. See the Camunda 8 REST API overview for further details.

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

decisionDefinitionKey int64

The assigned key, which acts as a unique identifier for this decision definition.

decisionDefinitionId string

The DMN id of the decision definition.

decisionDefinitionName string

The DMN name of the decision definition.

version int32

The assigned version of the decision definition.

decisionRequirementsId string

the DMN id of the decision requirements graph that the decision definition is part of.

decisionRequirementsKey int64

The assigned key of the decision requirements graph that the decision definition is part of.

tenantId string

The tenant id of the decision definition.

Responses

200

The Decision Definition Search successful response.

application/json

Schema

Schema

page object
totalItems int64
firstSortValues object[]
lastSortValues object[]
items object[]
Array [
decisionDefinitionKey int64
The assigned key, which acts as a unique identifier for this decision definition.
decisionDefinitionId string
The DMN id of the decision definition.
decisionDefinitionName string
The DMN name of the decision definition.
version int32
The assigned version of the decision definition.
decisionRequirementsId string
the DMN id of the decision requirements graph that the decision definition is part of.
decisionRequirementsKey int64
The assigned key of the decision requirements graph that the decision definition is part of.
tenantId string
The tenant id of the decision definition.
]

Example (from schema)

{
  "items": [
    {
      "decisionDefinitionKey": 0,
      "decisionDefinitionId": "string",
      "decisionDefinitionName": "string",
      "version": 0,
      "decisionRequirementsId": "string",
      "decisionRequirementsKey": 0,
      "tenantId": "string"
    }
  ],
  "page": {
    "totalItems": 0,
    "firstSortValues": [
      {}
    ],
    "lastSortValues": [
      {}
    ]
  }
}

400

The Decision Definition 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...