Get Decision Definition
Retrieves a decision definition by id, according to the DecisionDefinition
interface in the engine.
Method
GET /decision-definition/{id}
GET /decision-definition/key/{key}
(returns the latest version of the decision definition which belongs to no tenant)
GET /decision-definition/key/{key}/tenant-id/{tenant-id}
(returns the latest version of the decision definition for tenant)
Parameters
Path Parameters
Name | Description |
---|---|
id | The id of the decision definition to be retrieved. |
key | The key of the decision definition (the latest version thereof) to be retrieved. |
tenant-id | The id of the tenant the decision definition belongs to. |
Result
A JSON object corresponding to the DecisionDefinition
interface in the engine.
Its properties are as follows:
Name | Value | Description |
---|---|---|
id | String | The id of the decision definition. |
key | String | The key of the decision definition, i.e., the id of the DMN 1.0 XML decision definition. |
category | String | The category of the decision definition. |
name | String | The name of the decision definition. |
version | Number | The version of the decision definition that the engine assigned to it. |
resource | String | The file name of the decision definition. |
deploymentId | String | The deployment id of the decision definition. |
decisionRequirementsDefinitionId | String | The id of the decision requirements definition this decision definition belongs to. |
decisionRequirementsDefinitionKey | String | The key of the decision requirements definition this decision definition belongs to. |
tenantId | String | The tenant id of the decision definition. |
versionTag | String | The version tag of the process definition. |
historyTimeToLive | Number | History time to live value of the decision definition. Is used within History cleanup. |
Response codes
Code | Media type | Description |
---|---|---|
200 | application/json | Request successful. |
404 | application/json | Decision definition with given id or key does not exist. See the Introduction for the error response format. |
Example
Request
GET /decision-definition/aDecisionDefinitionId
GET /decision-definition/key/aDecisionDefinitionKey
Response
{
"id": "dish-decision:1:c633e8a8-41b7-11e6-b0ef-00aa004d0001",
"key": "dish-decision",
"category": "http://camunda.org/schema/1.0/dmn",
"name": "Dish Decision",
"version": 1,
"resource": "drd-dish-decision.dmn",
"deploymentId": "c627175e-41b7-11e6-b0ef-00aa004d0001",
"decisionRequirementsDefinitionId":"dish:1:c633c195-41b7-11e6-b0ef-00aa004d0001",
"decisionRequirementsDefinitionKey":"dish",
"tenantId": null,
"versionTag":null,
"historyTimeToLive": 5
}