Get Single Decision Definition

Retrieves a single decision definition according to the DecisionDefinition interface in the engine.

Method

GET /decision-definition/{id}

GET /decision-definition/key/{key} (returns the latest version of decision definition)

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.

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.

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":"aDecisionDefinitionId",
  "key":"aDecisionDefinitionKey",
  "category":"aCategory",
  "name":"aName",
  "version":42,
  "resource":"aResourceName",
  "deploymentId":"aDeploymentId"
}

On this Page: