Sign in
Decision Definition

Get List

Queries for decision definitions that fulfill given parameters. Parameters may be the properties of decision definitions, such as the name, key or version. The size of the result set can be retrieved by using the Get Decision Definition Count method.

get/decision-definition

Request

  • Base URL: http://localhost:8080/engine-rest
  • URL: http://localhost:8080/engine-rest/decision-definition
  • Auth: HTTP basic

Query parameters

sortBy'category' | 'decisionRequirementsDefinitionKey' | 'key' | 'id' | 'name' | 'version' | 'deploymentId' | 'deployTime' | 'versionTag' | 'tenantId'

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

sortOrder'asc' | 'desc'

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.

firstResultinteger

Pagination of results. Specifies the index of the first result to return.

maxResultsinteger

Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left.

decisionDefinitionIdstring

Filter by decision definition id.

decisionDefinitionIdInstring

Filter by decision definition ids.

namestring

Filter by decision definition name.

nameLikestring

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

deploymentIdstring

Filter by the deployment the id belongs to.

deployedAfterstring 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.

deployedAtstring 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).

keystring

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

keyLikestring

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

categorystring

Filter by decision definition category. Exact match.

categoryLikestring

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

versioninteger

Filter by decision definition version.

latestVersionboolean

Only include those decision definitions that are latest versions. Value may only be true, as false is the default behavior.

resourceNamestring

Filter by the name of the decision definition resource. Exact match.

resourceNameLikestring

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

decisionRequirementsDefinitionIdstring

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

decisionRequirementsDefinitionKeystring

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

withoutDecisionRequirementsDefinitionboolean

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

tenantIdInstring

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

withoutTenantIdboolean

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

includeDecisionDefinitionsWithoutTenantIdboolean

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.

versionTagstring

Filter by the version tag.

versionTagLikestring

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

Response

Request successful.

idstring nullable

The id of the decision definition

keystring nullable

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

categorystring nullable

The category of the decision definition.

namestring nullable

The name of the decision definition.

versioninteger nullable

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

resourcestring nullable

The file name of the decision definition.

deploymentIdstring nullable

The deployment id of the decision definition.

tenantIdstring nullable

The tenant id of the decision definition.

decisionRequirementsDefinitionIdstring nullable

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

decisionRequirementsDefinitionKeystring nullable

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

historyTimeToLiveinteger nullable

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

versionTagstring nullable

The version tag of the decision definition.

Changes

No recorded changes to this operation across all 1 revision of this API.