Query decision requirements (alpha)

POST 
/decision-requirements/search

Search for decision requirements 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

decisionRequirementsKey int64

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

name string

The DMN name of the decision requirements.

version int32

The assigned version of the decision requirements.

decisionRequirementsId string

the DMN ID of the decision requirements.

tenantId string

The tenant ID of the decision requirements.

Responses

200

The decision requirements search result.

application/json

Schema

Schema

page object
totalItems int64
firstSortValues object[]
lastSortValues object[]
items object[]
Array [
decisionRequirementsKey int64
The assigned key, which acts as a unique identifier for this decision requirements.
name string
The DMN name of the decision requirements.
version int32
The assigned version of the decision requirements.
decisionRequirementsId string
The DMN ID of the decision requirements.
resourceName string
The name of the resource from which this decision requirements was parsed.
tenantId string
The tenant ID of the decision requirements.
]

Example (from schema)

{
  "items": [
    {
      "decisionRequirementsKey": 0,
      "name": "string",
      "version": 0,
      "decisionRequirementsId": "string",
      "resourceName": "string",
      "tenantId": "string"
    }
  ],
  "page": {
    "totalItems": 0,
    "firstSortValues": [
      {}
    ],
    "lastSortValues": [
      {}
    ]
  }
}

400

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