Query decision definitions (alpha)

POST 
http://localhost:8080/v2/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 [

fieldstringrequired

orderstring

Default value: asc

]

page object

fromint32

limitint32

searchAfterobject[]

searchBeforeobject[]

filter objectdeprecated

Base properties for DecisionDefinitionFilterRequest

decisionDefinitionIdstring

The DMN id of the decision definition.

decisionDefinitionNamestring

The DMN name of the decision definition.

versionint32

The assigned version of the decision definition.

decisionRequirementsIdstring

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

tenantIdstring

The tenant id of the decision definition.

decisionDefinitionKeyint64

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

decisionRequirementsKeyint64

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

application/vnd.camunda.api.keys.number+json

Body

sort object[]

Array [

fieldstringrequired

orderstring

Default value: asc

]

page object

fromint32

limitint32

searchAfterobject[]

searchBeforeobject[]

filter objectdeprecated

Base properties for DecisionDefinitionFilterRequest

decisionDefinitionIdstring

The DMN id of the decision definition.

decisionDefinitionNamestring

The DMN name of the decision definition.

versionint32

The assigned version of the decision definition.

decisionRequirementsIdstring

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

tenantIdstring

The tenant id of the decision definition.

decisionDefinitionKeyint64

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

decisionRequirementsKeyint64

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

application/vnd.camunda.api.keys.string+json

Body

sort object[]

Array [

fieldstringrequired

orderstring

Default value: asc

]

page object

fromint32

limitint32

searchAfterobject[]

searchBeforeobject[]

filter objectdeprecated

Base properties for DecisionDefinitionFilterRequest

decisionDefinitionIdstring

The DMN id of the decision definition.

decisionDefinitionNamestring

The DMN name of the decision definition.

versionint32

The assigned version of the decision definition.

decisionRequirementsIdstring

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

tenantIdstring

The tenant id of the decision definition.

decisionDefinitionKeyint64

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

decisionRequirementsKeyint64

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

Responses

200

The Decision Definition Search successful response.

application/json

Schema

Schema

page object
totalItemsint64
firstSortValuesobject[]
lastSortValuesobject[]
items object[]
Array [
decisionDefinitionIdstring
The DMN id of the decision definition.
decisionDefinitionNamestring
The DMN name of the decision definition.
versionint32
The assigned version of the decision definition.
decisionRequirementsIdstring
the DMN id of the decision requirements graph that the decision definition is part of.
tenantIdstring
The tenant id of the decision definition.
decisionDefinitionKeyint64
The assigned key, which acts as a unique identifier for this decision definition.
decisionRequirementsKeyint64
The assigned key of the decision requirements graph that the decision definition is part of.
]

Example (auto)

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

application/vnd.camunda.api.keys.number+json

Schema

Schema

page object
totalItemsint64
firstSortValuesobject[]
lastSortValuesobject[]
items object[]
Array [
decisionDefinitionIdstring
The DMN id of the decision definition.
decisionDefinitionNamestring
The DMN name of the decision definition.
versionint32
The assigned version of the decision definition.
decisionRequirementsIdstring
the DMN id of the decision requirements graph that the decision definition is part of.
tenantIdstring
The tenant id of the decision definition.
decisionDefinitionKeyint64
The assigned key, which acts as a unique identifier for this decision definition.
decisionRequirementsKeyint64
The assigned key of the decision requirements graph that the decision definition is part of.
]

Example (auto)

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

application/vnd.camunda.api.keys.string+json

Schema

Schema

page object
totalItemsint64
firstSortValuesobject[]
lastSortValuesobject[]
items object[]
Array [
decisionDefinitionIdstring
The DMN id of the decision definition.
decisionDefinitionNamestring
The DMN name of the decision definition.
versionint32
The assigned version of the decision definition.
decisionRequirementsIdstring
the DMN id of the decision requirements graph that the decision definition is part of.
tenantIdstring
The tenant id of the decision definition.
decisionDefinitionKeystring
The assigned key, which acts as a unique identifier for this decision definition.
decisionRequirementsKeystring
The assigned key of the decision requirements graph that the decision definition is part of.
]

Example (auto)

{
  "items": [
    {
      "decisionDefinitionKey": "string",
      "decisionRequirementsKey": "string",
      "decisionDefinitionId": "string",
      "decisionDefinitionName": "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

typeuri

A URI identifying the problem type.

Default value: about:blank

titlestring

A summary of the problem type.

statusint32

The HTTP status code for this problem.

Possible values: >= 400 and <= 600

detailstring

An explanation of the problem in more detail.

instanceuri

A URI identifying the origin of the problem.

Example (auto)

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

typeuri

A URI identifying the problem type.

Default value: about:blank

titlestring

A summary of the problem type.

statusint32

The HTTP status code for this problem.

Possible values: >= 400 and <= 600

detailstring

An explanation of the problem in more detail.

instanceuri

A URI identifying the origin of the problem.

Example (auto)

{
  "type": "about:blank",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

• curl
• java
• nodejs
• csharp
• python
• go

• CURL

curl -L 'http://localhost:8080/v2/decision-definitions/search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
  "filter": {
    "decisionDefinitionId": "string",
    "decisionDefinitionName": "string",
    "version": 0,
    "decisionRequirementsId": "string",
    "tenantId": "string",
    "decisionDefinitionKey": 0,
    "decisionRequirementsKey": 0
  },
  "sort": [
    {
      "field": "string",
      "order": "asc"
    }
  ],
  "page": {
    "from": 0,
    "limit": 0,
    "searchAfter": [
      {}
    ],
    "searchBefore": [
      {}
    ]
  }
}'

Request Collapse all

Base URL

http://localhost:8080/v2

Body

Content-Type

application/jsonapplication/vnd.camunda.api.keys.number+jsonapplication/vnd.camunda.api.keys.string+json

{
  "filter": {
    "decisionDefinitionId": "string",
    "decisionDefinitionName": "string",
    "version": 0,
    "decisionRequirementsId": "string",
    "tenantId": "string",
    "decisionDefinitionKey": 0,
    "decisionRequirementsKey": 0
  },
  "sort": [
    {
      "field": "string",
      "order": "asc"
    }
  ],
  "page": {
    "from": 0,
    "limit": 0,
    "searchAfter": [
      {}
    ],
    "searchBefore": [
      {}
    ]
  }
}