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

Class HistoricBatchApi

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

  • Constructor Details

    • HistoricBatchApi

      public HistoricBatchApi()

    • HistoricBatchApi

      public HistoricBatchApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • deleteHistoricBatch

      public void deleteHistoricBatch(String id) throws ApiException
      Delete Historic Batch Deletes a historic batch by id, including related historic job logs.
      Parameters:
      id - The id of the batch to be deleted. (required)
      Throws:
      ApiException - if fails to make API call

    • deleteHistoricBatch

      public void deleteHistoricBatch(String id, Map<String,String> additionalHeaders) throws ApiException
      Delete Historic Batch Deletes a historic batch by id, including related historic job logs.
      Parameters:
      id - The id of the batch to be deleted. (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • getCleanableHistoricBatchesReport

      public List<CleanableHistoricBatchReportResultDto> getCleanableHistoricBatchesReport(String sortBy, String sortOrder, Integer firstResult, Integer maxResults) throws ApiException
      Get Cleanable Batch Report Retrieves a report about a historic batch operations 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 batches, cleanable batches and type of the batch. The size of the result set can be retrieved by using the [Get Cleanable Batch Report Count](https://docs.camunda.org/manual/7.21/reference/rest/history/batch/get-cleanable-batch-report-count/) method. **Please note:** The history time to live for batch operations does not support [Multi-Tenancy](https://docs.camunda.org/manual/7.21/user-guide/process-engine/multi-tenancy.md). The report will return an information for all batch operations (for all tenants) if you have permissions to see the history.
      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)
      Returns:
      List<CleanableHistoricBatchReportResultDto>
      Throws:
      ApiException - if fails to make API call

    • getCleanableHistoricBatchesReport

      public List<CleanableHistoricBatchReportResultDto> getCleanableHistoricBatchesReport(String sortBy, String sortOrder, Integer firstResult, Integer maxResults, Map<String,String> additionalHeaders) throws ApiException
      Get Cleanable Batch Report Retrieves a report about a historic batch operations 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 batches, cleanable batches and type of the batch. The size of the result set can be retrieved by using the [Get Cleanable Batch Report Count](https://docs.camunda.org/manual/7.21/reference/rest/history/batch/get-cleanable-batch-report-count/) method. **Please note:** The history time to live for batch operations does not support [Multi-Tenancy](https://docs.camunda.org/manual/7.21/user-guide/process-engine/multi-tenancy.md). The report will return an information for all batch operations (for all tenants) if you have permissions to see the history.
      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)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<CleanableHistoricBatchReportResultDto>
      Throws:
      ApiException - if fails to make API call

    • getCleanableHistoricBatchesReportCount

      public CountResultDto getCleanableHistoricBatchesReportCount() throws ApiException
      Get Cleanable Batch Report Count Queries for the number of report results about a historic batch operations 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 Batch Report](https://docs.camunda.org/manual/7.21/reference/rest/history/batch/get-cleanable-batch-report/) method.
      Returns:
      CountResultDto
      Throws:
      ApiException - if fails to make API call

    • getCleanableHistoricBatchesReportCount

      public CountResultDto getCleanableHistoricBatchesReportCount(Map<String,String> additionalHeaders) throws ApiException
      Get Cleanable Batch Report Count Queries for the number of report results about a historic batch operations 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 Batch Report](https://docs.camunda.org/manual/7.21/reference/rest/history/batch/get-cleanable-batch-report/) method.
      Parameters:
      additionalHeaders - additionalHeaders for this call
      Returns:
      CountResultDto
      Throws:
      ApiException - if fails to make API call

    • getHistoricBatch

      public HistoricBatchDto getHistoricBatch(String id) throws ApiException
      Get Historic Batch Retrieves a historic batch by id, according to the `HistoricBatch` interface in the engine.
      Parameters:
      id - The id of the historic batch to be retrieved. (required)
      Returns:
      HistoricBatchDto
      Throws:
      ApiException - if fails to make API call

    • getHistoricBatch

      public HistoricBatchDto getHistoricBatch(String id, Map<String,String> additionalHeaders) throws ApiException
      Get Historic Batch Retrieves a historic batch by id, according to the `HistoricBatch` interface in the engine.
      Parameters:
      id - The id of the historic batch to be retrieved. (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      HistoricBatchDto
      Throws:
      ApiException - if fails to make API call

    • getHistoricBatches

      public List<HistoricBatchDto> getHistoricBatches(String batchId, String type, Boolean completed, String tenantIdIn, Boolean withoutTenantId, String sortBy, String sortOrder, Integer firstResult, Integer maxResults) throws ApiException
      Get Historic Batches Queries for historic batches that fulfill given parameters. Parameters may be the properties of batches, such as the id or type. The size of the result set can be retrieved by using the [Get Historic Batch Count](https://docs.camunda.org/manual/7.21/reference/rest/history/batch/get-query-count/) method.
      Parameters:
      batchId - Filter by batch id. (optional)
      type - Filter by batch type. See the [User Guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/batch/#creating-a-batch) for more information about batch types. (optional)
      completed - Filter completed or not completed batches. If the value is `true`, only completed batches, i.e., end time is set, are returned. Otherwise, if the value is `false`, only running batches, i.e., end time is null, are returned. (optional)
      tenantIdIn - Filter by a comma-separated list of tenant ids. A batch matches if it has one of the given tenant ids. (optional)
      withoutTenantId - Only include batches which belong to no tenant. Value can effectively 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<HistoricBatchDto>
      Throws:
      ApiException - if fails to make API call

    • getHistoricBatches

      public List<HistoricBatchDto> getHistoricBatches(String batchId, String type, Boolean completed, String tenantIdIn, Boolean withoutTenantId, String sortBy, String sortOrder, Integer firstResult, Integer maxResults, Map<String,String> additionalHeaders) throws ApiException
      Get Historic Batches Queries for historic batches that fulfill given parameters. Parameters may be the properties of batches, such as the id or type. The size of the result set can be retrieved by using the [Get Historic Batch Count](https://docs.camunda.org/manual/7.21/reference/rest/history/batch/get-query-count/) method.
      Parameters:
      batchId - Filter by batch id. (optional)
      type - Filter by batch type. See the [User Guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/batch/#creating-a-batch) for more information about batch types. (optional)
      completed - Filter completed or not completed batches. If the value is `true`, only completed batches, i.e., end time is set, are returned. Otherwise, if the value is `false`, only running batches, i.e., end time is null, are returned. (optional)
      tenantIdIn - Filter by a comma-separated list of tenant ids. A batch matches if it has one of the given tenant ids. (optional)
      withoutTenantId - Only include batches which belong to no tenant. Value can effectively 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<HistoricBatchDto>
      Throws:
      ApiException - if fails to make API call

    • getHistoricBatchesCount

      public CountResultDto getHistoricBatchesCount(String batchId, String type, Boolean completed, String tenantIdIn, Boolean withoutTenantId) throws ApiException
      Get Historic Batch Count Requests the number of historic batches that fulfill the query criteria. Takes the same filtering parameters as the [Get Historic Batches](https://docs.camunda.org/manual/7.21/reference/rest/history/batch/get-query/) method.
      Parameters:
      batchId - Filter by batch id. (optional)
      type - Filter by batch type. See the [User Guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/batch/#creating-a-batch) for more information about batch types. (optional)
      completed - Filter completed or not completed batches. If the value is `true`, only completed batches, i.e., end time is set, are returned. Otherwise, if the value is `false`, only running batches, i.e., end time is null, are returned. (optional)
      tenantIdIn - Filter by a comma-separated list of tenant ids. A batch matches if it has one of the given tenant ids. (optional)
      withoutTenantId - Only include batches which belong to no tenant. Value can effectively only be `true`, as `false` is the default behavior. (optional)
      Returns:
      CountResultDto
      Throws:
      ApiException - if fails to make API call

    • getHistoricBatchesCount

      public CountResultDto getHistoricBatchesCount(String batchId, String type, Boolean completed, String tenantIdIn, Boolean withoutTenantId, Map<String,String> additionalHeaders) throws ApiException
      Get Historic Batch Count Requests the number of historic batches that fulfill the query criteria. Takes the same filtering parameters as the [Get Historic Batches](https://docs.camunda.org/manual/7.21/reference/rest/history/batch/get-query/) method.
      Parameters:
      batchId - Filter by batch id. (optional)
      type - Filter by batch type. See the [User Guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/batch/#creating-a-batch) for more information about batch types. (optional)
      completed - Filter completed or not completed batches. If the value is `true`, only completed batches, i.e., end time is set, are returned. Otherwise, if the value is `false`, only running batches, i.e., end time is null, are returned. (optional)
      tenantIdIn - Filter by a comma-separated list of tenant ids. A batch matches if it has one of the given tenant ids. (optional)
      withoutTenantId - Only include batches which belong to no tenant. Value can effectively 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

    • setRemovalTimeAsyncHistoricBatch

      public BatchDto setRemovalTimeAsyncHistoricBatch(SetRemovalTimeToHistoricBatchesDto setRemovalTimeToHistoricBatchesDto) throws ApiException
      Set Removal Time Async (POST) Sets the removal time to multiple historic batches asynchronously (batch). At least __historicBatchIds__ or __historicBatchQuery__ has to be provided. If both are provided, all instances matching query criterion and instances from the list will be updated with a removal time.
      Parameters:
      setRemovalTimeToHistoricBatchesDto - (optional)
      Returns:
      BatchDto
      Throws:
      ApiException - if fails to make API call

    • setRemovalTimeAsyncHistoricBatch

      public BatchDto setRemovalTimeAsyncHistoricBatch(SetRemovalTimeToHistoricBatchesDto setRemovalTimeToHistoricBatchesDto, Map<String,String> additionalHeaders) throws ApiException
      Set Removal Time Async (POST) Sets the removal time to multiple historic batches asynchronously (batch). At least __historicBatchIds__ or __historicBatchQuery__ has to be provided. If both are provided, all instances matching query criterion and instances from the list will be updated with a removal time.
      Parameters:
      setRemovalTimeToHistoricBatchesDto - (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      BatchDto
      Throws:
      ApiException - if fails to make API call