Package org.camunda.community.rest.client.api

Class HistoricDecisionDefinitionApi

java.lang.Object
org.camunda.community.rest.client.api.HistoricDecisionDefinitionApi
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2024-06-04T13:43:01.451833574Z[Etc/UTC]") public class HistoricDecisionDefinitionApi extends Object

  • Constructor Details

    • HistoricDecisionDefinitionApi

      public HistoricDecisionDefinitionApi()

    • HistoricDecisionDefinitionApi

      public HistoricDecisionDefinitionApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • getCleanableHistoricDecisionInstanceReport

      public List<CleanableHistoricDecisionInstanceReportResultDto> getCleanableHistoricDecisionInstanceReport(String decisionDefinitionIdIn, String decisionDefinitionKeyIn, String tenantIdIn, Boolean withoutTenantId, Boolean compact, String sortBy, String sortOrder, Integer firstResult, Integer maxResults) throws ApiException
      Get Cleanable Decision Instance Report Retrieves a report about a decision definition and finished decision instances relevant to history cleanup (see [History cleanup](https://docs.camunda.org/manual/7.21/user-guide/process-engine/history/#history-cleanup)), so that you can tune the history time to live. These reports include the count of the finished historic decision instances, cleanable decision instances and basic decision definition data - id, key, name and version. The size of the result set can be retrieved by using the [Get Cleanable Decision Instance Report Count](https://docs.camunda.org/manual/7.21/reference/rest/history/decision-definition/get-cleanable-decision-instance-report-count/) method.
      Parameters:
      decisionDefinitionIdIn - Filter by decision definition ids. Must be a comma-separated list of decision definition ids. (optional)
      decisionDefinitionKeyIn - Filter by decision definition keys. Must be a comma-separated list of decision definition keys. (optional)
      tenantIdIn - Filter by a comma-separated list of tenant ids. A decision definition must have one of the given tenant ids. (optional)
      withoutTenantId - Only include decision definitions which belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)
      compact - Only include decision instances which have more than zero finished instances. Value may only be `true`, as `false` is the default behavior. (optional)
      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)
      Returns:
      List<CleanableHistoricDecisionInstanceReportResultDto>
      Throws:
      ApiException - if fails to make API call

    • getCleanableHistoricDecisionInstanceReport

      public List<CleanableHistoricDecisionInstanceReportResultDto> getCleanableHistoricDecisionInstanceReport(String decisionDefinitionIdIn, String decisionDefinitionKeyIn, String tenantIdIn, Boolean withoutTenantId, Boolean compact, String sortBy, String sortOrder, Integer firstResult, Integer maxResults, Map<String,String> additionalHeaders) throws ApiException
      Get Cleanable Decision Instance Report Retrieves a report about a decision definition and finished decision instances relevant to history cleanup (see [History cleanup](https://docs.camunda.org/manual/7.21/user-guide/process-engine/history/#history-cleanup)), so that you can tune the history time to live. These reports include the count of the finished historic decision instances, cleanable decision instances and basic decision definition data - id, key, name and version. The size of the result set can be retrieved by using the [Get Cleanable Decision Instance Report Count](https://docs.camunda.org/manual/7.21/reference/rest/history/decision-definition/get-cleanable-decision-instance-report-count/) method.
      Parameters:
      decisionDefinitionIdIn - Filter by decision definition ids. Must be a comma-separated list of decision definition ids. (optional)
      decisionDefinitionKeyIn - Filter by decision definition keys. Must be a comma-separated list of decision definition keys. (optional)
      tenantIdIn - Filter by a comma-separated list of tenant ids. A decision definition must have one of the given tenant ids. (optional)
      withoutTenantId - Only include decision definitions which belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)
      compact - Only include decision instances which have more than zero finished instances. Value may only be `true`, as `false` is the default behavior. (optional)
      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)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<CleanableHistoricDecisionInstanceReportResultDto>
      Throws:
      ApiException - if fails to make API call

    • getCleanableHistoricDecisionInstanceReportCount

      public CountResultDto getCleanableHistoricDecisionInstanceReportCount(String decisionDefinitionIdIn, String decisionDefinitionKeyIn, String tenantIdIn, Boolean withoutTenantId, Boolean compact) throws ApiException
      Get Cleanable Decision Instance Report Count Queries for the number of report results about a decision definition and finished decision instances relevant to history cleanup (see [History cleanup](https://docs.camunda.org/manual/7.21/user-guide/process-engine/history/#history-cleanup)). Takes the same parameters as the [Get Cleanable Decision Instance Report](https://docs.camunda.org/manual/7.21/reference/rest/history/decision-definition/get-cleanable-decision-instance-report/) method.
      Parameters:
      decisionDefinitionIdIn - Filter by decision definition ids. Must be a comma-separated list of decision definition ids. (optional)
      decisionDefinitionKeyIn - Filter by decision definition keys. Must be a comma-separated list of decision definition keys. (optional)
      tenantIdIn - Filter by a comma-separated list of tenant ids. A decision definition must have one of the given tenant ids. (optional)
      withoutTenantId - Only include decision definitions which belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)
      compact - Only include decision instances which have more than zero finished instances. Value may only be `true`, as `false` is the default behavior. (optional)
      Returns:
      CountResultDto
      Throws:
      ApiException - if fails to make API call

    • getCleanableHistoricDecisionInstanceReportCount

      public CountResultDto getCleanableHistoricDecisionInstanceReportCount(String decisionDefinitionIdIn, String decisionDefinitionKeyIn, String tenantIdIn, Boolean withoutTenantId, Boolean compact, Map<String,String> additionalHeaders) throws ApiException
      Get Cleanable Decision Instance Report Count Queries for the number of report results about a decision definition and finished decision instances relevant to history cleanup (see [History cleanup](https://docs.camunda.org/manual/7.21/user-guide/process-engine/history/#history-cleanup)). Takes the same parameters as the [Get Cleanable Decision Instance Report](https://docs.camunda.org/manual/7.21/reference/rest/history/decision-definition/get-cleanable-decision-instance-report/) method.
      Parameters:
      decisionDefinitionIdIn - Filter by decision definition ids. Must be a comma-separated list of decision definition ids. (optional)
      decisionDefinitionKeyIn - Filter by decision definition keys. Must be a comma-separated list of decision definition keys. (optional)
      tenantIdIn - Filter by a comma-separated list of tenant ids. A decision definition must have one of the given tenant ids. (optional)
      withoutTenantId - Only include decision definitions which belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)
      compact - Only include decision instances which have more than zero finished instances. Value may only be `true`, as `false` is the default behavior. (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      CountResultDto
      Throws:
      ApiException - if fails to make API call