Package org.openapitools.client.api

Class HistoricBatchApi

  • public class HistoricBatchApi
extends Object

    • Constructor Detail

      • HistoricBatchApi

        public HistoricBatchApi()

      • HistoricBatchApi

        public HistoricBatchApi​(ApiClient apiClient)

    • Method Detail

      • getApiClient

        public ApiClient getApiClient()

      • setApiClient

        public void setApiClient​(ApiClient apiClient)

      • deleteHistoricBatchCall

        public okhttp3.Call deleteHistoricBatchCall​(String id,
                                            ApiCallback _callback)
                                     throws ApiException
        Build call for deleteHistoricBatch
        Parameters:
        id - The id of the batch to be deleted. (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • 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 fail to call the API, e.g. server error or cannot deserialize the response body

      • deleteHistoricBatchWithHttpInfo

        public ApiResponse<Void> deleteHistoricBatchWithHttpInfo​(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)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • deleteHistoricBatchAsync

        public okhttp3.Call deleteHistoricBatchAsync​(String id,
                                             ApiCallback<Void> _callback)
                                      throws ApiException
        Delete Historic Batch (asynchronously) Deletes a historic batch by id, including related historic job logs.
        Parameters:
        id - The id of the batch to be deleted. (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • getCleanableHistoricBatchesReportCall

        public okhttp3.Call getCleanableHistoricBatchesReportCall​(String sortBy,
                                                          String sortOrder,
                                                          Integer firstResult,
                                                          Integer maxResults,
                                                          ApiCallback _callback)
                                                   throws ApiException
        Build call for getCleanableHistoricBatchesReport
        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)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • 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.18/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.18/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.18/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 fail to call the API, e.g. server error or cannot deserialize the response body

      • getCleanableHistoricBatchesReportWithHttpInfo

        public ApiResponse<List<CleanableHistoricBatchReportResultDto>> getCleanableHistoricBatchesReportWithHttpInfo​(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.18/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.18/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.18/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:
        ApiResponse<List<CleanableHistoricBatchReportResultDto>>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getCleanableHistoricBatchesReportAsync

        public okhttp3.Call getCleanableHistoricBatchesReportAsync​(String sortBy,
                                                           String sortOrder,
                                                           Integer firstResult,
                                                           Integer maxResults,
                                                           ApiCallback<List<CleanableHistoricBatchReportResultDto>> _callback)
                                                    throws ApiException
        Get Cleanable Batch Report (asynchronously) Retrieves a report about a historic batch operations relevant to history cleanup (see [History cleanup](https://docs.camunda.org/manual/7.18/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.18/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.18/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)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • getCleanableHistoricBatchesReportCountCall

        public okhttp3.Call getCleanableHistoricBatchesReportCountCall​(String sortBy,
                                                               String sortOrder,
                                                               Integer firstResult,
                                                               Integer maxResults,
                                                               ApiCallback _callback)
                                                        throws ApiException
        Build call for getCleanableHistoricBatchesReportCount
        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)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getCleanableHistoricBatchesReportCount

        public CountResultDto getCleanableHistoricBatchesReportCount​(String sortBy,
                                                             String sortOrder,
                                                             Integer firstResult,
                                                             Integer maxResults)
                                                      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.18/user-guide/process-engine/history/#history-cleanup) ). Takes the same parameters as the [Get Cleanable Batch Report](https://docs.camunda.org/manual/7.18/reference/rest/history/batch/get-cleanable-batch-report/) 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)
        Returns:
        CountResultDto
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getCleanableHistoricBatchesReportCountWithHttpInfo

        public ApiResponse<CountResultDto> getCleanableHistoricBatchesReportCountWithHttpInfo​(String sortBy,
                                                                                      String sortOrder,
                                                                                      Integer firstResult,
                                                                                      Integer maxResults)
                                                                               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.18/user-guide/process-engine/history/#history-cleanup) ). Takes the same parameters as the [Get Cleanable Batch Report](https://docs.camunda.org/manual/7.18/reference/rest/history/batch/get-cleanable-batch-report/) 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)
        Returns:
        ApiResponse<CountResultDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getCleanableHistoricBatchesReportCountAsync

        public okhttp3.Call getCleanableHistoricBatchesReportCountAsync​(String sortBy,
                                                                String sortOrder,
                                                                Integer firstResult,
                                                                Integer maxResults,
                                                                ApiCallback<CountResultDto> _callback)
                                                         throws ApiException
        Get Cleanable Batch Report Count (asynchronously) 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.18/user-guide/process-engine/history/#history-cleanup) ). Takes the same parameters as the [Get Cleanable Batch Report](https://docs.camunda.org/manual/7.18/reference/rest/history/batch/get-cleanable-batch-report/) 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)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • getHistoricBatchCall

        public okhttp3.Call getHistoricBatchCall​(String id,
                                         ApiCallback _callback)
                                  throws ApiException
        Build call for getHistoricBatch
        Parameters:
        id - The id of the historic batch to be retrieved. (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • 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 fail to call the API, e.g. server error or cannot deserialize the response body

      • getHistoricBatchWithHttpInfo

        public ApiResponse<HistoricBatchDto> getHistoricBatchWithHttpInfo​(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:
        ApiResponse<HistoricBatchDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getHistoricBatchAsync

        public okhttp3.Call getHistoricBatchAsync​(String id,
                                          ApiCallback<HistoricBatchDto> _callback)
                                   throws ApiException
        Get Historic Batch (asynchronously) 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)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • getHistoricBatchesCall

        public okhttp3.Call getHistoricBatchesCall​(String batchId,
                                           String type,
                                           Boolean completed,
                                           String tenantIdIn,
                                           Boolean withoutTenantId,
                                           String sortBy,
                                           String sortOrder,
                                           Integer firstResult,
                                           Integer maxResults,
                                           ApiCallback _callback)
                                    throws ApiException
        Build call for getHistoricBatches
        Parameters:
        batchId - Filter by batch id. (optional)
        type - Filter by batch type. See the [User Guide](https://docs.camunda.org/manual/7.18/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)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • 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.18/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.18/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 fail to call the API, e.g. server error or cannot deserialize the response body

      • getHistoricBatchesWithHttpInfo

        public ApiResponse<List<HistoricBatchDto>> getHistoricBatchesWithHttpInfo​(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.18/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.18/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:
        ApiResponse<List<HistoricBatchDto>>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getHistoricBatchesAsync

        public okhttp3.Call getHistoricBatchesAsync​(String batchId,
                                            String type,
                                            Boolean completed,
                                            String tenantIdIn,
                                            Boolean withoutTenantId,
                                            String sortBy,
                                            String sortOrder,
                                            Integer firstResult,
                                            Integer maxResults,
                                            ApiCallback<List<HistoricBatchDto>> _callback)
                                     throws ApiException
        Get Historic Batches (asynchronously) 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.18/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.18/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)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • getHistoricBatchesCountCall

        public okhttp3.Call getHistoricBatchesCountCall​(String batchId,
                                                String type,
                                                Boolean completed,
                                                String tenantIdIn,
                                                Boolean withoutTenantId,
                                                ApiCallback _callback)
                                         throws ApiException
        Build call for getHistoricBatchesCount
        Parameters:
        batchId - Filter by batch id. (optional)
        type - Filter by batch type. See the [User Guide](https://docs.camunda.org/manual/7.18/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)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • 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.18/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.18/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 fail to call the API, e.g. server error or cannot deserialize the response body

      • getHistoricBatchesCountWithHttpInfo

        public ApiResponse<CountResultDto> getHistoricBatchesCountWithHttpInfo​(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.18/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.18/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:
        ApiResponse<CountResultDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getHistoricBatchesCountAsync

        public okhttp3.Call getHistoricBatchesCountAsync​(String batchId,
                                                 String type,
                                                 Boolean completed,
                                                 String tenantIdIn,
                                                 Boolean withoutTenantId,
                                                 ApiCallback<CountResultDto> _callback)
                                          throws ApiException
        Get Historic Batch Count (asynchronously) 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.18/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.18/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)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • setRemovalTimeAsyncHistoricBatchCall

        public okhttp3.Call setRemovalTimeAsyncHistoricBatchCall​(SetRemovalTimeToHistoricBatchesDto setRemovalTimeToHistoricBatchesDto,
                                                         ApiCallback _callback)
                                                  throws ApiException
        Build call for setRemovalTimeAsyncHistoricBatch
        Parameters:
        setRemovalTimeToHistoricBatchesDto - (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • 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 fail to call the API, e.g. server error or cannot deserialize the response body

      • setRemovalTimeAsyncHistoricBatchWithHttpInfo

        public ApiResponse<BatchDto> setRemovalTimeAsyncHistoricBatchWithHttpInfo​(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:
        ApiResponse<BatchDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • setRemovalTimeAsyncHistoricBatchAsync

        public okhttp3.Call setRemovalTimeAsyncHistoricBatchAsync​(SetRemovalTimeToHistoricBatchesDto setRemovalTimeToHistoricBatchesDto,
                                                          ApiCallback<BatchDto> _callback)
                                                   throws ApiException
        Set Removal Time Async (POST) (asynchronously) 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)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object