Sign in
Decision Requirements Definition

Get Decision Requirements Definitions

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

get/decision-requirements-definition

Request

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

Query parameters

decisionRequirementsDefinitionIdstring

Filter by decision requirements definition id.

decisionRequirementsDefinitionIdInstring

Filter by decision requirements definition ids.

namestring

Filter by decision requirements definition name.

nameLikestring

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

deploymentIdstring

Filter by the id of the deployment a decision requirement definition belongs to.

keystring

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

keyLikestring

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

categorystring

Filter by decision requirements definition category. Exact match.

categoryLikestring

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

versioninteger

Filter by decision requirements definition version.

latestVersionboolean

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

resourceNamestring

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

resourceNameLikestring

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

tenantIdInstring

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

withoutTenantIdboolean

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

includeDecisionRequirementsDefinitionsWithoutTenantIdboolean

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

sortBy'id' | 'key' | 'name' | 'version' | 'deploymentId' | 'category' | '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.

Response

Request successful.

idstring nullable

The id of the decision requirements definition

keystring nullable

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

namestring nullable

The name of the decision requirements definition.

categorystring nullable

The category of the decision requirements definition.

versioninteger nullable

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

resourcestring nullable

The file name of the decision requirements definition.

deploymentIdstring nullable

The deployment id of the decision requirements definition.

tenantIdstring nullable

The tenant id of the decisionrequirements definition.

Changes

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