Class DecisionDefinitionApi
java.lang.Object
org.camunda.community.rest.client.api.DecisionDefinitionApi
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
date="2024-06-04T13:43:01.451833574Z[Etc/UTC]")
public class DecisionDefinitionApi
extends Object
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionevaluateDecisionById(String id, EvaluateDecisionDto evaluateDecisionDto) Evaluate By Id Evaluates a given decision and returns the result.evaluateDecisionById(String id, EvaluateDecisionDto evaluateDecisionDto, Map<String, String> additionalHeaders) Evaluate By Id Evaluates a given decision and returns the result.evaluateDecisionByKey(String key, EvaluateDecisionDto evaluateDecisionDto) Evaluate By Key Evaluates the latest version of the decision definition which belongs to no tenant.evaluateDecisionByKey(String key, EvaluateDecisionDto evaluateDecisionDto, Map<String, String> additionalHeaders) Evaluate By Key Evaluates the latest version of the decision definition which belongs to no tenant.evaluateDecisionByKeyAndTenant(String key, String tenantId, EvaluateDecisionDto evaluateDecisionDto) Evaluate By Key And Tenant Evaluates the latest version of the decision definition for tenant.evaluateDecisionByKeyAndTenant(String key, String tenantId, EvaluateDecisionDto evaluateDecisionDto, Map<String, String> additionalHeaders) Evaluate By Key And Tenant Evaluates the latest version of the decision definition for tenant.Get Decision Definition By Id Retrieves a decision definition by id, according to the `DecisionDefinition` interface in the engine.getDecisionDefinitionById(String id, Map<String, String> additionalHeaders) Get Decision Definition By Id Retrieves a decision definition by id, according to the `DecisionDefinition` interface in the engine.Get Decision Definition By Key Retrieves the latest version of the decision definition which belongs to no tenant.getDecisionDefinitionByKey(String key, Map<String, String> additionalHeaders) Get Decision Definition By Key Retrieves the latest version of the decision definition which belongs to no tenant.getDecisionDefinitionByKeyAndTenantId(String key, String tenantId) Get Decision Definition By Key And Tenant Id Retrieves the latest version of the decision definition for tenantgetDecisionDefinitionByKeyAndTenantId(String key, String tenantId, Map<String, String> additionalHeaders) Get Decision Definition By Key And Tenant Id Retrieves the latest version of the decision definition for tenantGet Diagram Retrieves the diagram of a decision definition.getDecisionDefinitionDiagram(String id, Map<String, String> additionalHeaders) Get Diagram Retrieves the diagram of a decision definition.Get Diagram By Key Returns the diagram for the latest version of the decision definition which belongs to no tenantgetDecisionDefinitionDiagramByKey(String key, Map<String, String> additionalHeaders) Get Diagram By Key Returns the diagram for the latest version of the decision definition which belongs to no tenantgetDecisionDefinitionDiagramByKeyAndTenant(String key, String tenantId) Get Diagram By Key And Tenant Returns the XML of the latest version of the decision definition for tenant.getDecisionDefinitionDiagramByKeyAndTenant(String key, String tenantId, Map<String, String> additionalHeaders) Get Diagram By Key And Tenant Returns the XML of the latest version of the decision definition for tenant.Get XML By Id Retrieves the DMN XML of a decision definition.getDecisionDefinitionDmnXmlById(String id, Map<String, String> additionalHeaders) Get XML By Id Retrieves the DMN XML of a decision definition.Get XML By Key Retrieves the XML for the latest version of the decision definition which belongs to no tenant.getDecisionDefinitionDmnXmlByKey(String key, Map<String, String> additionalHeaders) Get XML By Key Retrieves the XML for the latest version of the decision definition which belongs to no tenant.getDecisionDefinitionDmnXmlByKeyAndTenant(String key, String tenantId) Get XML By Key and Tenant Retrieves the XML of the latest version of the decision definition for tenantgetDecisionDefinitionDmnXmlByKeyAndTenant(String key, String tenantId, Map<String, String> additionalHeaders) Get XML By Key and Tenant Retrieves the XML of the latest version of the decision definition for tenantgetDecisionDefinitions(String sortBy, String sortOrder, Integer firstResult, Integer maxResults, String decisionDefinitionId, String decisionDefinitionIdIn, String name, String nameLike, String deploymentId, OffsetDateTime deployedAfter, OffsetDateTime deployedAt, String key, String keyLike, String category, String categoryLike, Integer version, Boolean latestVersion, String resourceName, String resourceNameLike, String decisionRequirementsDefinitionId, String decisionRequirementsDefinitionKey, Boolean withoutDecisionRequirementsDefinition, String tenantIdIn, Boolean withoutTenantId, Boolean includeDecisionDefinitionsWithoutTenantId, String versionTag, String versionTagLike) Get List Queries for decision definitions that fulfill given parameters.getDecisionDefinitions(String sortBy, String sortOrder, Integer firstResult, Integer maxResults, String decisionDefinitionId, String decisionDefinitionIdIn, String name, String nameLike, String deploymentId, OffsetDateTime deployedAfter, OffsetDateTime deployedAt, String key, String keyLike, String category, String categoryLike, Integer version, Boolean latestVersion, String resourceName, String resourceNameLike, String decisionRequirementsDefinitionId, String decisionRequirementsDefinitionKey, Boolean withoutDecisionRequirementsDefinition, String tenantIdIn, Boolean withoutTenantId, Boolean includeDecisionDefinitionsWithoutTenantId, String versionTag, String versionTagLike, Map<String, String> additionalHeaders) Get List Queries for decision definitions that fulfill given parameters.getDecisionDefinitionsCount(String decisionDefinitionId, String decisionDefinitionIdIn, String name, String nameLike, String deploymentId, OffsetDateTime deployedAfter, OffsetDateTime deployedAt, String key, String keyLike, String category, String categoryLike, Integer version, Boolean latestVersion, String resourceName, String resourceNameLike, String decisionRequirementsDefinitionId, String decisionRequirementsDefinitionKey, Boolean withoutDecisionRequirementsDefinition, String tenantIdIn, Boolean withoutTenantId, Boolean includeDecisionDefinitionsWithoutTenantId, String versionTag, String versionTagLike) Get List Count Requests the number of decision definitions that fulfill the query criteria.getDecisionDefinitionsCount(String decisionDefinitionId, String decisionDefinitionIdIn, String name, String nameLike, String deploymentId, OffsetDateTime deployedAfter, OffsetDateTime deployedAt, String key, String keyLike, String category, String categoryLike, Integer version, Boolean latestVersion, String resourceName, String resourceNameLike, String decisionRequirementsDefinitionId, String decisionRequirementsDefinitionKey, Boolean withoutDecisionRequirementsDefinition, String tenantIdIn, Boolean withoutTenantId, Boolean includeDecisionDefinitionsWithoutTenantId, String versionTag, String versionTagLike, Map<String, String> additionalHeaders) Get List Count Requests the number of decision definitions that fulfill the query criteria.voidsetApiClient(ApiClient apiClient) voidupdateHistoryTimeToLiveByDecisionDefinitionId(String id, HistoryTimeToLiveDto historyTimeToLiveDto) Update History Time to Live Updates history time to live for decision definition.voidupdateHistoryTimeToLiveByDecisionDefinitionId(String id, HistoryTimeToLiveDto historyTimeToLiveDto, Map<String, String> additionalHeaders) Update History Time to Live Updates history time to live for decision definition.voidupdateHistoryTimeToLiveByDecisionDefinitionKey(String key, HistoryTimeToLiveDto historyTimeToLiveDto) Update History Time to Live By Key Updates the latest version of the decision definition which belongs to no tenant.voidupdateHistoryTimeToLiveByDecisionDefinitionKey(String key, HistoryTimeToLiveDto historyTimeToLiveDto, Map<String, String> additionalHeaders) Update History Time to Live By Key Updates the latest version of the decision definition which belongs to no tenant.voidupdateHistoryTimeToLiveByDecisionDefinitionKeyAndTenant(String key, String tenantId, HistoryTimeToLiveDto historyTimeToLiveDto) Update History Time to Live By Key And Tenant Updates the latest version of the decision definition for tenant.voidupdateHistoryTimeToLiveByDecisionDefinitionKeyAndTenant(String key, String tenantId, HistoryTimeToLiveDto historyTimeToLiveDto, Map<String, String> additionalHeaders) Update History Time to Live By Key And Tenant Updates the latest version of the decision definition for tenant.
-
Constructor Details
-
DecisionDefinitionApi
public DecisionDefinitionApi() -
DecisionDefinitionApi
-
-
Method Details
-
getApiClient
-
setApiClient
-
evaluateDecisionById
public List<Map<String,VariableValueDto>> evaluateDecisionById(String id, EvaluateDecisionDto evaluateDecisionDto) throws ApiException Evaluate By Id Evaluates a given decision and returns the result. The input values of the decision have to be supplied in the request body.- Parameters:
id- The id of the decision definition to be evaluated. (required)evaluateDecisionDto- (optional)- Returns:
- List<Map<String, VariableValueDto>>
- Throws:
ApiException- if fails to make API call
-
evaluateDecisionById
public List<Map<String,VariableValueDto>> evaluateDecisionById(String id, EvaluateDecisionDto evaluateDecisionDto, Map<String, String> additionalHeaders) throws ApiExceptionEvaluate By Id Evaluates a given decision and returns the result. The input values of the decision have to be supplied in the request body.- Parameters:
id- The id of the decision definition to be evaluated. (required)evaluateDecisionDto- (optional)additionalHeaders- additionalHeaders for this call- Returns:
- List<Map<String, VariableValueDto>>
- Throws:
ApiException- if fails to make API call
-
evaluateDecisionByKey
public List<Map<String,VariableValueDto>> evaluateDecisionByKey(String key, EvaluateDecisionDto evaluateDecisionDto) throws ApiException Evaluate By Key Evaluates the latest version of the decision definition which belongs to no tenant. The input values of the decision have to be supplied in the request body.- Parameters:
key- The key of the decision definition (the latest version thereof) to be evaluated. (required)evaluateDecisionDto- (optional)- Returns:
- List<Map<String, VariableValueDto>>
- Throws:
ApiException- if fails to make API call
-
evaluateDecisionByKey
public List<Map<String,VariableValueDto>> evaluateDecisionByKey(String key, EvaluateDecisionDto evaluateDecisionDto, Map<String, String> additionalHeaders) throws ApiExceptionEvaluate By Key Evaluates the latest version of the decision definition which belongs to no tenant. The input values of the decision have to be supplied in the request body.- Parameters:
key- The key of the decision definition (the latest version thereof) to be evaluated. (required)evaluateDecisionDto- (optional)additionalHeaders- additionalHeaders for this call- Returns:
- List<Map<String, VariableValueDto>>
- Throws:
ApiException- if fails to make API call
-
evaluateDecisionByKeyAndTenant
public List<Map<String,VariableValueDto>> evaluateDecisionByKeyAndTenant(String key, String tenantId, EvaluateDecisionDto evaluateDecisionDto) throws ApiException Evaluate By Key And Tenant Evaluates the latest version of the decision definition for tenant. The input values of the decision have to be supplied in the request body.- Parameters:
key- The key of the decision definition (the latest version thereof) to be evaluated. (required)tenantId- The id of the tenant the decision definition belongs to. (required)evaluateDecisionDto- (optional)- Returns:
- List<Map<String, VariableValueDto>>
- Throws:
ApiException- if fails to make API call
-
evaluateDecisionByKeyAndTenant
public List<Map<String,VariableValueDto>> evaluateDecisionByKeyAndTenant(String key, String tenantId, EvaluateDecisionDto evaluateDecisionDto, Map<String, String> additionalHeaders) throws ApiExceptionEvaluate By Key And Tenant Evaluates the latest version of the decision definition for tenant. The input values of the decision have to be supplied in the request body.- Parameters:
key- The key of the decision definition (the latest version thereof) to be evaluated. (required)tenantId- The id of the tenant the decision definition belongs to. (required)evaluateDecisionDto- (optional)additionalHeaders- additionalHeaders for this call- Returns:
- List<Map<String, VariableValueDto>>
- Throws:
ApiException- if fails to make API call
-
getDecisionDefinitionById
Get Decision Definition By Id Retrieves a decision definition by id, according to the `DecisionDefinition` interface in the engine.- Parameters:
id- The id of the decision definition to be retrieved. (required)- Returns:
- DecisionDefinitionDto
- Throws:
ApiException- if fails to make API call
-
getDecisionDefinitionById
public DecisionDefinitionDto getDecisionDefinitionById(String id, Map<String, String> additionalHeaders) throws ApiExceptionGet Decision Definition By Id Retrieves a decision definition by id, according to the `DecisionDefinition` interface in the engine.- Parameters:
id- The id of the decision definition to be retrieved. (required)additionalHeaders- additionalHeaders for this call- Returns:
- DecisionDefinitionDto
- Throws:
ApiException- if fails to make API call
-
getDecisionDefinitionByKey
Get Decision Definition By Key Retrieves the latest version of the decision definition which belongs to no tenant.- Parameters:
key- The key of the decision definition (the latest version thereof) to be retrieved. (required)- Returns:
- DecisionDefinitionDto
- Throws:
ApiException- if fails to make API call
-
getDecisionDefinitionByKey
public DecisionDefinitionDto getDecisionDefinitionByKey(String key, Map<String, String> additionalHeaders) throws ApiExceptionGet Decision Definition By Key Retrieves the latest version of the decision definition which belongs to no tenant.- Parameters:
key- The key of the decision definition (the latest version thereof) to be retrieved. (required)additionalHeaders- additionalHeaders for this call- Returns:
- DecisionDefinitionDto
- Throws:
ApiException- if fails to make API call
-
getDecisionDefinitionByKeyAndTenantId
public DecisionDefinitionDto getDecisionDefinitionByKeyAndTenantId(String key, String tenantId) throws ApiException Get Decision Definition By Key And Tenant Id Retrieves the latest version of the decision definition for tenant- Parameters:
key- The key of the decision definition (the latest version thereof) to be retrieved. (required)tenantId- The id of the tenant the decision definition belongs to. (required)- Returns:
- DecisionDefinitionDto
- Throws:
ApiException- if fails to make API call
-
getDecisionDefinitionByKeyAndTenantId
public DecisionDefinitionDto getDecisionDefinitionByKeyAndTenantId(String key, String tenantId, Map<String, String> additionalHeaders) throws ApiExceptionGet Decision Definition By Key And Tenant Id Retrieves the latest version of the decision definition for tenant- Parameters:
key- The key of the decision definition (the latest version thereof) to be retrieved. (required)tenantId- The id of the tenant the decision definition belongs to. (required)additionalHeaders- additionalHeaders for this call- Returns:
- DecisionDefinitionDto
- Throws:
ApiException- if fails to make API call
-
getDecisionDefinitionDiagram
Get Diagram Retrieves the diagram of a decision definition.- Parameters:
id- The id of the process definition. (required)- Returns:
- File
- Throws:
ApiException- if fails to make API call
-
getDecisionDefinitionDiagram
public File getDecisionDefinitionDiagram(String id, Map<String, String> additionalHeaders) throws ApiExceptionGet Diagram Retrieves the diagram of a decision definition.- Parameters:
id- The id of the process definition. (required)additionalHeaders- additionalHeaders for this call- Returns:
- File
- Throws:
ApiException- if fails to make API call
-
getDecisionDefinitionDiagramByKey
Get Diagram By Key Returns the diagram for the latest version of the decision definition which belongs to no tenant- Parameters:
key- The key of the decision definition (the latest version thereof) to be retrieved. (required)- Returns:
- File
- Throws:
ApiException- if fails to make API call
-
getDecisionDefinitionDiagramByKey
public File getDecisionDefinitionDiagramByKey(String key, Map<String, String> additionalHeaders) throws ApiExceptionGet Diagram By Key Returns the diagram for the latest version of the decision definition which belongs to no tenant- Parameters:
key- The key of the decision definition (the latest version thereof) to be retrieved. (required)additionalHeaders- additionalHeaders for this call- Returns:
- File
- Throws:
ApiException- if fails to make API call
-
getDecisionDefinitionDiagramByKeyAndTenant
public File getDecisionDefinitionDiagramByKeyAndTenant(String key, String tenantId) throws ApiException Get Diagram By Key And Tenant Returns the XML of the latest version of the decision definition for tenant.- Parameters:
key- The key of the decision definition (the latest version thereof) to be retrieved. (required)tenantId- The id of the tenant the decision definition belongs to. (required)- Returns:
- File
- Throws:
ApiException- if fails to make API call
-
getDecisionDefinitionDiagramByKeyAndTenant
public File getDecisionDefinitionDiagramByKeyAndTenant(String key, String tenantId, Map<String, String> additionalHeaders) throws ApiExceptionGet Diagram By Key And Tenant Returns the XML of the latest version of the decision definition for tenant.- Parameters:
key- The key of the decision definition (the latest version thereof) to be retrieved. (required)tenantId- The id of the tenant the decision definition belongs to. (required)additionalHeaders- additionalHeaders for this call- Returns:
- File
- Throws:
ApiException- if fails to make API call
-
getDecisionDefinitionDmnXmlById
Get XML By Id Retrieves the DMN XML of a decision definition.- Parameters:
id- The id of the decision definition. (required)- Returns:
- DecisionDefinitionDiagramDto
- Throws:
ApiException- if fails to make API call
-
getDecisionDefinitionDmnXmlById
public DecisionDefinitionDiagramDto getDecisionDefinitionDmnXmlById(String id, Map<String, String> additionalHeaders) throws ApiExceptionGet XML By Id Retrieves the DMN XML of a decision definition.- Parameters:
id- The id of the decision definition. (required)additionalHeaders- additionalHeaders for this call- Returns:
- DecisionDefinitionDiagramDto
- Throws:
ApiException- if fails to make API call
-
getDecisionDefinitionDmnXmlByKey
public DecisionDefinitionDiagramDto getDecisionDefinitionDmnXmlByKey(String key) throws ApiException Get XML By Key Retrieves the XML for the latest version of the decision definition which belongs to no tenant.- Parameters:
key- The key of the decision definition (the latest version thereof). (required)- Returns:
- DecisionDefinitionDiagramDto
- Throws:
ApiException- if fails to make API call
-
getDecisionDefinitionDmnXmlByKey
public DecisionDefinitionDiagramDto getDecisionDefinitionDmnXmlByKey(String key, Map<String, String> additionalHeaders) throws ApiExceptionGet XML By Key Retrieves the XML for the latest version of the decision definition which belongs to no tenant.- Parameters:
key- The key of the decision definition (the latest version thereof). (required)additionalHeaders- additionalHeaders for this call- Returns:
- DecisionDefinitionDiagramDto
- Throws:
ApiException- if fails to make API call
-
getDecisionDefinitionDmnXmlByKeyAndTenant
public DecisionDefinitionDiagramDto getDecisionDefinitionDmnXmlByKeyAndTenant(String key, String tenantId) throws ApiException Get XML By Key and Tenant Retrieves the XML of the latest version of the decision definition for tenant- Parameters:
key- The key of the decision definition (the latest version thereof). (required)tenantId- The id of the tenant the decision definition belongs to. (required)- Returns:
- DecisionDefinitionDiagramDto
- Throws:
ApiException- if fails to make API call
-
getDecisionDefinitionDmnXmlByKeyAndTenant
public DecisionDefinitionDiagramDto getDecisionDefinitionDmnXmlByKeyAndTenant(String key, String tenantId, Map<String, String> additionalHeaders) throws ApiExceptionGet XML By Key and Tenant Retrieves the XML of the latest version of the decision definition for tenant- Parameters:
key- The key of the decision definition (the latest version thereof). (required)tenantId- The id of the tenant the decision definition belongs to. (required)additionalHeaders- additionalHeaders for this call- Returns:
- DecisionDefinitionDiagramDto
- Throws:
ApiException- if fails to make API call
-
getDecisionDefinitions
public List<DecisionDefinitionDto> getDecisionDefinitions(String sortBy, String sortOrder, Integer firstResult, Integer maxResults, String decisionDefinitionId, String decisionDefinitionIdIn, String name, String nameLike, String deploymentId, OffsetDateTime deployedAfter, OffsetDateTime deployedAt, String key, String keyLike, String category, String categoryLike, Integer version, Boolean latestVersion, String resourceName, String resourceNameLike, String decisionRequirementsDefinitionId, String decisionRequirementsDefinitionKey, Boolean withoutDecisionRequirementsDefinition, String tenantIdIn, Boolean withoutTenantId, Boolean includeDecisionDefinitionsWithoutTenantId, String versionTag, String versionTagLike) throws ApiException 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](https://docs.camunda.org/manual/7.21/reference/rest/decision-definition/get-query-count/) method.- Parameters:
sortBy- Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter. (optional)sortOrder- 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. (optional)firstResult- Pagination of results. Specifies the index of the first result to return. (optional)maxResults- Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. (optional)decisionDefinitionId- Filter by decision definition id. (optional)decisionDefinitionIdIn- Filter by decision definition ids. (optional)name- Filter by decision definition name. (optional)nameLike- Filter by decision definition names that the parameter is a substring of. (optional)deploymentId- Filter by the deployment the id belongs to. (optional)deployedAfter- 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. (optional)deployedAt- 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). (optional)key- Filter by decision definition key, i.e., the id in the DMN 1.0 XML. Exact match. (optional)keyLike- Filter by decision definition keys that the parameter is a substring of. (optional)category- Filter by decision definition category. Exact match. (optional)categoryLike- Filter by decision definition categories that the parameter is a substring of. (optional)version- Filter by decision definition version. (optional)latestVersion- Only include those decision definitions that are latest versions. Value may only be `true`, as `false` is the default behavior. (optional)resourceName- Filter by the name of the decision definition resource. Exact match. (optional)resourceNameLike- Filter by names of those decision definition resources that the parameter is a substring of. (optional)decisionRequirementsDefinitionId- Filter by the id of the decision requirements definition this decision definition belongs to. (optional)decisionRequirementsDefinitionKey- Filter by the key of the decision requirements definition this decision definition belongs to. (optional)withoutDecisionRequirementsDefinition- Only include decision definitions which does not belongs to any decision requirements definition. Value may only be `true`, as `false` is the default behavior. (optional)tenantIdIn- Filter by a comma-separated list of `Strings`. A decision definition must have one of the given tenant ids. (optional)withoutTenantId- Only include decision definitions which belong to no tenant. Value can effectively only be `true`, as `false` is the default behavior. (optional)includeDecisionDefinitionsWithoutTenantId- 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. (optional)versionTag- Filter by the version tag. (optional)versionTagLike- Filter by the version tags of those decision definition resources that the parameter is a substring of. (optional)- Returns:
- List<DecisionDefinitionDto>
- Throws:
ApiException- if fails to make API call
-
getDecisionDefinitions
public List<DecisionDefinitionDto> getDecisionDefinitions(String sortBy, String sortOrder, Integer firstResult, Integer maxResults, String decisionDefinitionId, String decisionDefinitionIdIn, String name, String nameLike, String deploymentId, OffsetDateTime deployedAfter, OffsetDateTime deployedAt, String key, String keyLike, String category, String categoryLike, Integer version, Boolean latestVersion, String resourceName, String resourceNameLike, String decisionRequirementsDefinitionId, String decisionRequirementsDefinitionKey, Boolean withoutDecisionRequirementsDefinition, String tenantIdIn, Boolean withoutTenantId, Boolean includeDecisionDefinitionsWithoutTenantId, String versionTag, String versionTagLike, Map<String, String> additionalHeaders) throws ApiExceptionGet 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](https://docs.camunda.org/manual/7.21/reference/rest/decision-definition/get-query-count/) method.- Parameters:
sortBy- Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter. (optional)sortOrder- 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. (optional)firstResult- Pagination of results. Specifies the index of the first result to return. (optional)maxResults- Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. (optional)decisionDefinitionId- Filter by decision definition id. (optional)decisionDefinitionIdIn- Filter by decision definition ids. (optional)name- Filter by decision definition name. (optional)nameLike- Filter by decision definition names that the parameter is a substring of. (optional)deploymentId- Filter by the deployment the id belongs to. (optional)deployedAfter- 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. (optional)deployedAt- 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). (optional)key- Filter by decision definition key, i.e., the id in the DMN 1.0 XML. Exact match. (optional)keyLike- Filter by decision definition keys that the parameter is a substring of. (optional)category- Filter by decision definition category. Exact match. (optional)categoryLike- Filter by decision definition categories that the parameter is a substring of. (optional)version- Filter by decision definition version. (optional)latestVersion- Only include those decision definitions that are latest versions. Value may only be `true`, as `false` is the default behavior. (optional)resourceName- Filter by the name of the decision definition resource. Exact match. (optional)resourceNameLike- Filter by names of those decision definition resources that the parameter is a substring of. (optional)decisionRequirementsDefinitionId- Filter by the id of the decision requirements definition this decision definition belongs to. (optional)decisionRequirementsDefinitionKey- Filter by the key of the decision requirements definition this decision definition belongs to. (optional)withoutDecisionRequirementsDefinition- Only include decision definitions which does not belongs to any decision requirements definition. Value may only be `true`, as `false` is the default behavior. (optional)tenantIdIn- Filter by a comma-separated list of `Strings`. A decision definition must have one of the given tenant ids. (optional)withoutTenantId- Only include decision definitions which belong to no tenant. Value can effectively only be `true`, as `false` is the default behavior. (optional)includeDecisionDefinitionsWithoutTenantId- 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. (optional)versionTag- Filter by the version tag. (optional)versionTagLike- Filter by the version tags of those decision definition resources that the parameter is a substring of. (optional)additionalHeaders- additionalHeaders for this call- Returns:
- List<DecisionDefinitionDto>
- Throws:
ApiException- if fails to make API call
-
getDecisionDefinitionsCount
public CountResultDto getDecisionDefinitionsCount(String decisionDefinitionId, String decisionDefinitionIdIn, String name, String nameLike, String deploymentId, OffsetDateTime deployedAfter, OffsetDateTime deployedAt, String key, String keyLike, String category, String categoryLike, Integer version, Boolean latestVersion, String resourceName, String resourceNameLike, String decisionRequirementsDefinitionId, String decisionRequirementsDefinitionKey, Boolean withoutDecisionRequirementsDefinition, String tenantIdIn, Boolean withoutTenantId, Boolean includeDecisionDefinitionsWithoutTenantId, String versionTag, String versionTagLike) throws ApiException Get List Count Requests the number of decision definitions that fulfill the query criteria. Takes the same filtering parameters as the [Get Decision Definition](https://docs.camunda.org/manual/7.21/reference/rest/decision-definition/get-query/) method.- Parameters:
decisionDefinitionId- Filter by decision definition id. (optional)decisionDefinitionIdIn- Filter by decision definition ids. (optional)name- Filter by decision definition name. (optional)nameLike- Filter by decision definition names that the parameter is a substring of. (optional)deploymentId- Filter by the deployment the id belongs to. (optional)deployedAfter- 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. (optional)deployedAt- 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). (optional)key- Filter by decision definition key, i.e., the id in the DMN 1.0 XML. Exact match. (optional)keyLike- Filter by decision definition keys that the parameter is a substring of. (optional)category- Filter by decision definition category. Exact match. (optional)categoryLike- Filter by decision definition categories that the parameter is a substring of. (optional)version- Filter by decision definition version. (optional)latestVersion- Only include those decision definitions that are latest versions. Value may only be `true`, as `false` is the default behavior. (optional)resourceName- Filter by the name of the decision definition resource. Exact match. (optional)resourceNameLike- Filter by names of those decision definition resources that the parameter is a substring of. (optional)decisionRequirementsDefinitionId- Filter by the id of the decision requirements definition this decision definition belongs to. (optional)decisionRequirementsDefinitionKey- Filter by the key of the decision requirements definition this decision definition belongs to. (optional)withoutDecisionRequirementsDefinition- Only include decision definitions which does not belongs to any decision requirements definition. Value may only be `true`, as `false` is the default behavior. (optional)tenantIdIn- Filter by a comma-separated list of `Strings`. A decision definition must have one of the given tenant ids. (optional)withoutTenantId- Only include decision definitions which belong to no tenant. Value can effectively only be `true`, as `false` is the default behavior. (optional)includeDecisionDefinitionsWithoutTenantId- 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. (optional)versionTag- Filter by the version tag. (optional)versionTagLike- Filter by the version tags of those decision definition resources that the parameter is a substring of. (optional)- Returns:
- CountResultDto
- Throws:
ApiException- if fails to make API call
-
getDecisionDefinitionsCount
public CountResultDto getDecisionDefinitionsCount(String decisionDefinitionId, String decisionDefinitionIdIn, String name, String nameLike, String deploymentId, OffsetDateTime deployedAfter, OffsetDateTime deployedAt, String key, String keyLike, String category, String categoryLike, Integer version, Boolean latestVersion, String resourceName, String resourceNameLike, String decisionRequirementsDefinitionId, String decisionRequirementsDefinitionKey, Boolean withoutDecisionRequirementsDefinition, String tenantIdIn, Boolean withoutTenantId, Boolean includeDecisionDefinitionsWithoutTenantId, String versionTag, String versionTagLike, Map<String, String> additionalHeaders) throws ApiExceptionGet List Count Requests the number of decision definitions that fulfill the query criteria. Takes the same filtering parameters as the [Get Decision Definition](https://docs.camunda.org/manual/7.21/reference/rest/decision-definition/get-query/) method.- Parameters:
decisionDefinitionId- Filter by decision definition id. (optional)decisionDefinitionIdIn- Filter by decision definition ids. (optional)name- Filter by decision definition name. (optional)nameLike- Filter by decision definition names that the parameter is a substring of. (optional)deploymentId- Filter by the deployment the id belongs to. (optional)deployedAfter- 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. (optional)deployedAt- 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). (optional)key- Filter by decision definition key, i.e., the id in the DMN 1.0 XML. Exact match. (optional)keyLike- Filter by decision definition keys that the parameter is a substring of. (optional)category- Filter by decision definition category. Exact match. (optional)categoryLike- Filter by decision definition categories that the parameter is a substring of. (optional)version- Filter by decision definition version. (optional)latestVersion- Only include those decision definitions that are latest versions. Value may only be `true`, as `false` is the default behavior. (optional)resourceName- Filter by the name of the decision definition resource. Exact match. (optional)resourceNameLike- Filter by names of those decision definition resources that the parameter is a substring of. (optional)decisionRequirementsDefinitionId- Filter by the id of the decision requirements definition this decision definition belongs to. (optional)decisionRequirementsDefinitionKey- Filter by the key of the decision requirements definition this decision definition belongs to. (optional)withoutDecisionRequirementsDefinition- Only include decision definitions which does not belongs to any decision requirements definition. Value may only be `true`, as `false` is the default behavior. (optional)tenantIdIn- Filter by a comma-separated list of `Strings`. A decision definition must have one of the given tenant ids. (optional)withoutTenantId- Only include decision definitions which belong to no tenant. Value can effectively only be `true`, as `false` is the default behavior. (optional)includeDecisionDefinitionsWithoutTenantId- 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. (optional)versionTag- Filter by the version tag. (optional)versionTagLike- Filter by the version tags of those decision definition resources that the parameter is a substring of. (optional)additionalHeaders- additionalHeaders for this call- Returns:
- CountResultDto
- Throws:
ApiException- if fails to make API call
-
updateHistoryTimeToLiveByDecisionDefinitionId
public void updateHistoryTimeToLiveByDecisionDefinitionId(String id, HistoryTimeToLiveDto historyTimeToLiveDto) throws ApiException Update History Time to Live Updates history time to live for decision definition. The field is used within [History cleanup](https://docs.camunda.org/manual/7.21/user-guide/process-engine/history/#history-cleanup).- Parameters:
id- The id of the decision definition to change history time to live. (required)historyTimeToLiveDto- (optional)- Throws:
ApiException- if fails to make API call
-
updateHistoryTimeToLiveByDecisionDefinitionId
public void updateHistoryTimeToLiveByDecisionDefinitionId(String id, HistoryTimeToLiveDto historyTimeToLiveDto, Map<String, String> additionalHeaders) throws ApiExceptionUpdate History Time to Live Updates history time to live for decision definition. The field is used within [History cleanup](https://docs.camunda.org/manual/7.21/user-guide/process-engine/history/#history-cleanup).- Parameters:
id- The id of the decision definition to change history time to live. (required)historyTimeToLiveDto- (optional)additionalHeaders- additionalHeaders for this call- Throws:
ApiException- if fails to make API call
-
updateHistoryTimeToLiveByDecisionDefinitionKey
public void updateHistoryTimeToLiveByDecisionDefinitionKey(String key, HistoryTimeToLiveDto historyTimeToLiveDto) throws ApiException Update History Time to Live By Key Updates the latest version of the decision definition which belongs to no tenant. The field is used within [History cleanup](https://docs.camunda.org/manual/7.21/user-guide/process-engine/history/#history-cleanup).- Parameters:
key- The key of the decision definitions to change history time to live. (required)historyTimeToLiveDto- (optional)- Throws:
ApiException- if fails to make API call
-
updateHistoryTimeToLiveByDecisionDefinitionKey
public void updateHistoryTimeToLiveByDecisionDefinitionKey(String key, HistoryTimeToLiveDto historyTimeToLiveDto, Map<String, String> additionalHeaders) throws ApiExceptionUpdate History Time to Live By Key Updates the latest version of the decision definition which belongs to no tenant. The field is used within [History cleanup](https://docs.camunda.org/manual/7.21/user-guide/process-engine/history/#history-cleanup).- Parameters:
key- The key of the decision definitions to change history time to live. (required)historyTimeToLiveDto- (optional)additionalHeaders- additionalHeaders for this call- Throws:
ApiException- if fails to make API call
-
updateHistoryTimeToLiveByDecisionDefinitionKeyAndTenant
public void updateHistoryTimeToLiveByDecisionDefinitionKeyAndTenant(String key, String tenantId, HistoryTimeToLiveDto historyTimeToLiveDto) throws ApiException Update History Time to Live By Key And Tenant Updates the latest version of the decision definition for tenant. The field is used within [History cleanup](https://docs.camunda.org/manual/7.21/user-guide/process-engine/history/#history-cleanup). The value of the update is mandatory by default and does not allow `null` values. To enable them, please set the feature flag `enforceHistoryTimeToLive` to `false`. Read more in [Configuration Properties] (https://docs.camunda.org/manual/7.21/reference/deployment-descriptors/tags/process-engine#configuration-properties)- Parameters:
key- The key of the decision definitions to change history time to live. (required)tenantId- The id of the tenant the decision definition belongs to. (required)historyTimeToLiveDto- (optional)- Throws:
ApiException- if fails to make API call
-
updateHistoryTimeToLiveByDecisionDefinitionKeyAndTenant
public void updateHistoryTimeToLiveByDecisionDefinitionKeyAndTenant(String key, String tenantId, HistoryTimeToLiveDto historyTimeToLiveDto, Map<String, String> additionalHeaders) throws ApiExceptionUpdate History Time to Live By Key And Tenant Updates the latest version of the decision definition for tenant. The field is used within [History cleanup](https://docs.camunda.org/manual/7.21/user-guide/process-engine/history/#history-cleanup). The value of the update is mandatory by default and does not allow `null` values. To enable them, please set the feature flag `enforceHistoryTimeToLive` to `false`. Read more in [Configuration Properties] (https://docs.camunda.org/manual/7.21/reference/deployment-descriptors/tags/process-engine#configuration-properties)- Parameters:
key- The key of the decision definitions to change history time to live. (required)tenantId- The id of the tenant the decision definition belongs to. (required)historyTimeToLiveDto- (optional)additionalHeaders- additionalHeaders for this call- Throws:
ApiException- if fails to make API call
-