Get Decision Requirements Definition

Retrieves a decision requirements definition according to the DecisionRequirementsDefinition interface in the engine.

Method

GET /decision-requirements-definition/{id}

GET /decision-requirements-definition/key/{key} (returns the latest version of the decision requirements definition which belongs to no tenant)

GET /decision-requirements-definition/key/{key}/tenant-id/{tenant-id} (returns the latest version of the decision requirements definition for tenant)

Parameters

Path Parameters

Name Description
id The id of the decision requirements definition to be retrieved.
key The key of the decision requirements definition (the latest version thereof) to be retrieved.
tenant-id The id of the tenant to which the decision requirements definition belongs to.

Result

A JSON object corresponding to the DecisionRequirementsDefinition interface in the engine. Its properties are as follows:

Name Type Description
id String The id of the decision requirements definition.
key String The key of the decision requirements definition, i.e., the id of the DMN 1.3 XML decision 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.
404 application/json Decision requirements definition with given id or key does not exist. See the Introduction for the error response format.

Example

Request

GET /decision-requirements-definition/invoice:1:9f86d61f-9ee5-11e3-be3b-606720b6f99c

GET /decision-requirements-definition/key/invoiceKey

Response

{
  "id":"invoice:1:9f86d61f-9ee5-11e3-be3b-606720b6f99c",
  "key":"invoiceKey",
  "category":"invoice",
  "name":"receiptInvoice",
  "version":2,
  "resource":"invoice.dmn",
  "deploymentId":"c627175e-41b7-11e6-b0ef-00aa004d0001",
  "tenantId": null
}

On this Page: