Skip to main content
GET
/
decision-definition
Get List
curl --request GET \
  --url http://{host}:{port}/{contextPath}/decision-definition \
  --header 'Authorization: Basic <encoded-value>'
[
  {
    "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
  }
]

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

sortBy
enum<string>

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

Available options:
category,
decisionRequirementsDefinitionKey,
key,
id,
name,
version,
deploymentId,
deployTime,
versionTag,
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.

decisionDefinitionId
string

Filter by decision definition id.

decisionDefinitionIdIn
string

Filter by decision definition ids.

name
string

Filter by decision definition name.

nameLike
string

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

deploymentId
string

Filter by the deployment the id belongs to.

deployedAfter
string<date-time>

Filter by the deploy time of the deployment the decision definition belongs to. Only selects decision definitions that have been deployed after (exclusive) a specific time.

deployedAt
string<date-time>

Filter by the deploy time of the deployment the decision definition belongs to. Only selects decision definitions that have been deployed at a specific time (exact match).

key
string

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

keyLike
string

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

category
string

Filter by decision definition category. Exact match.

categoryLike
string

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

version
integer

Filter by decision definition version.

latestVersion
boolean

Only include those decision 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 definition resource. Exact match.

resourceNameLike
string

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

decisionRequirementsDefinitionId
string

Filter by the id of the decision requirements definition this decision definition belongs to.

decisionRequirementsDefinitionKey
string

Filter by the key of the decision requirements definition this decision definition belongs to.

withoutDecisionRequirementsDefinition
boolean

Only include decision definitions which does not belongs to any decision requirements definition. Value may only be true, as false is the default behavior.

tenantIdIn
string

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

withoutTenantId
boolean

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

includeDecisionDefinitionsWithoutTenantId
boolean

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

versionTag
string

Filter by the version tag.

versionTagLike
string

Filter by the version tags of those decision definition resources that the parameter is a substring of.

Response

Request successful.

id
string | null

The id of the decision definition

key
string | null

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

category
string | null

The category of the decision definition.

name
string | null

The name of the decision definition.

version
integer | null

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

resource
string | null

The file name of the decision definition.

deploymentId
string | null

The deployment id of the decision definition.

tenantId
string | null

The tenant id of the decision definition.

decisionRequirementsDefinitionId
string | null

The id of the decision requirements definition this decision definition belongs to.

decisionRequirementsDefinitionKey
string | null

The key of the decision requirements definition this decision definition belongs to.

historyTimeToLive
integer | null

History time to live value of the decision definition. Is used within History cleanup.

Required range: x >= 0
versionTag
string | null

The version tag of the decision definition.