Query decision definitions

POST 
/decision-definitions/search

Search for decision definitions 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 definition search filter.

decisionDefinitionKey int64

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

decisionDefinitionId string

The DMN ID of the decision definition.

name 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 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 definitions.
Array [
decisionDefinitionKey string
The assigned key, which acts as a unique identifier for this decision definition.
decisionRequirementsKey string
The assigned key of the decision requirements graph that the decision definition is part of.
]

Example (from schema)

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

application/vnd.camunda.api.keys.number+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 definitions.
Array [
decisionDefinitionKey int64
The assigned key, which acts as a unique identifier for this decision definition.
decisionRequirementsKey int64
The assigned key of the decision requirements graph that the decision definition is part of.
]

Example (from schema)

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

application/vnd.camunda.api.keys.string+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 definitions.
Array [
decisionDefinitionKey string
The assigned key, which acts as a unique identifier for this decision definition.
decisionRequirementsKey string
The assigned key of the decision requirements graph that the decision definition is part of.
]

Example (from schema)

{
  "items": [
    {
      "decisionDefinitionKey": "string",
      "decisionRequirementsKey": "string",
      "decisionDefinitionId": "string",
      "name": "string",
      "version": 0,
      "decisionRequirementsId": "string",
      "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"
}

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