Get Decision Requirements Definitions
Queries for decision requirements definitions that fulfill given parameters. Parameters may be the properties of decision requirements definitions, such as the name, key or version. The size of the result set can be retrieved by using the Get Decision Requirements Definition Count method.
Method
GET /decision-requirements-definition
Parameters
Query Parameters
Name | Description |
---|---|
decisionRequirementsDefinitionId | Filter by decision requirements definition id. |
decisionRequirementsDefinitionIdIn | Filter by decision requirements definition ids. |
name | Filter by decision requirements definition name. |
nameLike | Filter by decision requirements definition names that the parameter is a substring of. |
deploymentId | Filter by the deployment the id belongs to. |
key | Filter by decision requirements definition key, i.e., the id in the DMN 1.1 XML. Exact match. |
keyLike | Filter by decision requirements definition keys that the parameter is a substring of. |
category | Filter by decision requirements definition category. Exact match. |
categoryLike | Filter by decision requirements definition categories that the parameter is a substring of. |
version | Filter by decision requirements definition version. |
latestVersion | Only include those decision requirements definitions that are latest versions. Value may only be true , as false is the default behavior. |
resourceName | Filter by the name of the decision requirements definition resource. Exact match. |
resourceNameLike | Filter by names of those decision requirements definition resources that the parameter is a substring of. |
tenantIdIn | Filter by a comma-separated list of tenant ids. A decision requirements definition must have one of the given tenant ids. |
withoutTenantId | Only include decision requirements definitions which belong to no tenant. Value may only be true , as false is the default behavior. |
includeDecisionRequirementsDefinitionsWithoutTenantId | 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 | Sort the results lexicographically by a given criterion. Valid values are
category , key , id , name , version , deploymentId and tenantId .
Must be used in conjunction with the sortOrder parameter. |
sortOrder | 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. |
firstResult | Pagination of results. Specifies the index of the first result to return. |
maxResults | Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. |
Result
A JSON array of decision requirements definition objects. Each decision requirements definition object has the following properties:
Name | Value | Description |
---|---|---|
id | String | The id of the decision requirements definition. |
key | String | The key of the decision requirements definition. |
category | String | The category of the decision requirements definition. |
name | String | The name of the decision requirements definition. |
version | Number | The version of the decision requirements definition that the engine assigned to it. |
resource | String | The file name of the decision requirements definition. |
deploymentId | String | The deployment id of the decision requirements definition. |
tenantId | String | The tenant id of the decision requirements definition. |
Response codes
Code | Media type | Description |
---|---|---|
200 | application/json | Request successful. |
400 | application/json |
Returned if some of the query parameters are invalid, for example if a sortOrder parameter is supplied, but no sortBy .
See the Introduction for the error response format.
|
Example
Request
GET /decision-requirements-definition?key=dish&sortBy=version&sortOrder=asc
Response
[
{
"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
}
]