Skip to main content
GET
/
decision-requirements-definition
Get Decision Requirements Definitions
curl --request GET \
  --url http://{host}:{port}/{contextPath}/decision-requirements-definition \
  --header 'Authorization: Basic <encoded-value>'
[
  {
    "id": "dish:1:c633c195-41b7-11e6-b0ef-00aa004d0001",
    "key": "dish",
    "category": "drd-test",
    "name": "Dish",
    "version": 1,
    "resource": "dish.dmn",
    "deploymentId": "c627175e-41b7-11e6-b0ef-00aa004d0001",
    "tenantId": null
  }
]

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Query Parameters

​
decisionRequirementsDefinitionId
string

Filter by decision requirements definition id.

​
decisionRequirementsDefinitionIdIn
string

Filter by decision requirements definition ids.

​
name
string

Filter by decision requirements definition name.

​
nameLike
string

Filter by decision requirements definition names that the parameter is a substring of.

​
deploymentId
string

Filter by the id of the deployment a decision requirement definition belongs to.

​
key
string

Filter by decision requirements definition key, i.e., the id in the DMN 1.3 XML. Exact match.

​
keyLike
string

Filter by decision requirements definition keys that the parameter is a substring of.

​
category
string

Filter by decision requirements definition category. Exact match.

​
categoryLike
string

Filter by decision requirements definition categories that the parameter is a substring of.

​
version
integer

Filter by decision requirements definition version.

​
latestVersion
boolean

Only include those decision requirements definitions that are latest versions. Value may only be true, as false is the default behavior.

​
resourceName
string

Filter by the name of the decision requirements definition resource. Exact match.

​
resourceNameLike
string

Filter by names of those decision requirements definition resources that the parameter is a substring of.

​
tenantIdIn
string

Filter by a comma-separated list of tenant ids. A decision requirements definition must have one of the given tenant ids.

​
withoutTenantId
boolean

Only include decision requirements definitions which belong to no tenant. Value may only be true, as false is the default behavior.

​
includeDecisionRequirementsDefinitionsWithoutTenantId
boolean

Include decision requirements definitions which belong to no tenant. Can be used in combination with tenantIdIn. Value may only be true, as false is the default behavior.

​
sortBy
enum<string>

Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter.

Available options:
id,
key,
name,
version,
deploymentId,
category,
tenantId
​
sortOrder
enum<string>

Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter.

Available options:
asc,
desc
​
firstResult
integer

Pagination of results. Specifies the index of the first result to return.

​
maxResults
integer

Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left.

Response

Request successful.

​
id
string | null

The id of the decision requirements definition

​
key
string | null

The key of the decision requirements definition, i.e., the id of the DMN 1.0 XML decision definition.

​
name
string | null

The name of the decision requirements definition.

​
category
string | null

The category of the decision requirements definition.

​
version
integer | null

The version of the decision requirements definition that the engine assigned to it.

​
resource
string | null

The file name of the decision requirements definition.

​
deploymentId
string | null

The deployment id of the decision requirements definition.

​
tenantId
string | null

The tenant id of the decisionrequirements definition.