Package org.openapitools.client.api

Class BatchApi

  • public class BatchApi
extends Object

    • Constructor Detail

      • BatchApi

        public BatchApi()

      • BatchApi

        public BatchApi​(ApiClient apiClient)

    • Method Detail

      • getApiClient

        public ApiClient getApiClient()

      • setApiClient

        public void setApiClient​(ApiClient apiClient)

      • deleteBatchCall

        public okhttp3.Call deleteBatchCall​(String id,
                                    Boolean cascade,
                                    ApiCallback _callback)
                             throws ApiException
        Build call for deleteBatch
        Parameters:
        id - The id of the batch to be deleted. (required)
        cascade - `true`, if the historic batch and historic job logs for this batch should also be deleted. (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • deleteBatch

        public void deleteBatch​(String id,
                        Boolean cascade)
                 throws ApiException
        Delete Deletes a batch by id, including all related jobs and job definitions. Optionally also deletes the batch history.
        Parameters:
        id - The id of the batch to be deleted. (required)
        cascade - `true`, if the historic batch and historic job logs for this batch should also be deleted. (optional)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • deleteBatchWithHttpInfo

        public ApiResponse<Void> deleteBatchWithHttpInfo​(String id,
                                                 Boolean cascade)
                                          throws ApiException
        Delete Deletes a batch by id, including all related jobs and job definitions. Optionally also deletes the batch history.
        Parameters:
        id - The id of the batch to be deleted. (required)
        cascade - `true`, if the historic batch and historic job logs for this batch should also be deleted. (optional)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • deleteBatchAsync

        public okhttp3.Call deleteBatchAsync​(String id,
                                     Boolean cascade,
                                     ApiCallback<Void> _callback)
                              throws ApiException
        Delete (asynchronously) Deletes a batch by id, including all related jobs and job definitions. Optionally also deletes the batch history.
        Parameters:
        id - The id of the batch to be deleted. (required)
        cascade - `true`, if the historic batch and historic job logs for this batch should also be deleted. (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

      • getBatchCall

        public okhttp3.Call getBatchCall​(String id,
                                 ApiCallback _callback)
                          throws ApiException
        Build call for getBatch
        Parameters:
        id - The id of the 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

      • getBatch

        public BatchDto getBatch​(String id)
                  throws ApiException
        Get Retrieves a batch by id, according to the Batch interface in the engine.
        Parameters:
        id - The id of the batch to be retrieved. (required)
        Returns:
        BatchDto
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getBatchWithHttpInfo

        public ApiResponse<BatchDto> getBatchWithHttpInfo​(String id)
                                           throws ApiException
        Get Retrieves a batch by id, according to the Batch interface in the engine.
        Parameters:
        id - The id of the batch to be retrieved. (required)
        Returns:
        ApiResponse<BatchDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getBatchAsync

        public okhttp3.Call getBatchAsync​(String id,
                                  ApiCallback<BatchDto> _callback)
                           throws ApiException
        Get (asynchronously) Retrieves a batch by id, according to the Batch interface in the engine.
        Parameters:
        id - The id of the 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

      • getBatchStatisticsCall

        public okhttp3.Call getBatchStatisticsCall​(String sortBy,
                                           String sortOrder,
                                           Integer firstResult,
                                           Integer maxResults,
                                           String batchId,
                                           String type,
                                           String tenantIdIn,
                                           Boolean withoutTenantId,
                                           Boolean suspended,
                                           String createdBy,
                                           Date startedBefore,
                                           Date startedAfter,
                                           Boolean withFailures,
                                           Boolean withoutFailures,
                                           ApiCallback _callback)
                                    throws ApiException
        Build call for getBatchStatistics
        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)
        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)
        tenantIdIn - Filter by a comma-separated list of `Strings`. 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)
        suspended - A `Boolean` value which indicates whether only active or suspended batches should be included. When the value is set to `true`, only suspended batches will be returned and when the value is set to `false`, only active batches will be returned. (optional)
        createdBy - Only include batches that were started by this user id. (optional)
        startedBefore - Only include batches that were started before the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)
        startedAfter - Only include batches that were started after the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)
        withFailures - Only include batches having jobs with failures. Value can only be `true`. (optional)
        withoutFailures - Only include batches having jobs without failures. Value can only be `true`. (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getBatchStatistics

        public List<BatchStatisticsDto> getBatchStatistics​(String sortBy,
                                                   String sortOrder,
                                                   Integer firstResult,
                                                   Integer maxResults,
                                                   String batchId,
                                                   String type,
                                                   String tenantIdIn,
                                                   Boolean withoutTenantId,
                                                   Boolean suspended,
                                                   String createdBy,
                                                   Date startedBefore,
                                                   Date startedAfter,
                                                   Boolean withFailures,
                                                   Boolean withoutFailures)
                                            throws ApiException
        Get Statistics Queries for batch statistics 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 Batch Statistics Count](https://docs.camunda.org/manual/7.18/reference/rest/batch/get-statistics-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)
        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)
        tenantIdIn - Filter by a comma-separated list of `Strings`. 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)
        suspended - A `Boolean` value which indicates whether only active or suspended batches should be included. When the value is set to `true`, only suspended batches will be returned and when the value is set to `false`, only active batches will be returned. (optional)
        createdBy - Only include batches that were started by this user id. (optional)
        startedBefore - Only include batches that were started before the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)
        startedAfter - Only include batches that were started after the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)
        withFailures - Only include batches having jobs with failures. Value can only be `true`. (optional)
        withoutFailures - Only include batches having jobs without failures. Value can only be `true`. (optional)
        Returns:
        List<BatchStatisticsDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getBatchStatisticsWithHttpInfo

        public ApiResponse<List<BatchStatisticsDto>> getBatchStatisticsWithHttpInfo​(String sortBy,
                                                                            String sortOrder,
                                                                            Integer firstResult,
                                                                            Integer maxResults,
                                                                            String batchId,
                                                                            String type,
                                                                            String tenantIdIn,
                                                                            Boolean withoutTenantId,
                                                                            Boolean suspended,
                                                                            String createdBy,
                                                                            Date startedBefore,
                                                                            Date startedAfter,
                                                                            Boolean withFailures,
                                                                            Boolean withoutFailures)
                                                                     throws ApiException
        Get Statistics Queries for batch statistics 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 Batch Statistics Count](https://docs.camunda.org/manual/7.18/reference/rest/batch/get-statistics-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)
        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)
        tenantIdIn - Filter by a comma-separated list of `Strings`. 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)
        suspended - A `Boolean` value which indicates whether only active or suspended batches should be included. When the value is set to `true`, only suspended batches will be returned and when the value is set to `false`, only active batches will be returned. (optional)
        createdBy - Only include batches that were started by this user id. (optional)
        startedBefore - Only include batches that were started before the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)
        startedAfter - Only include batches that were started after the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)
        withFailures - Only include batches having jobs with failures. Value can only be `true`. (optional)
        withoutFailures - Only include batches having jobs without failures. Value can only be `true`. (optional)
        Returns:
        ApiResponse<List<BatchStatisticsDto>>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getBatchStatisticsAsync

        public okhttp3.Call getBatchStatisticsAsync​(String sortBy,
                                            String sortOrder,
                                            Integer firstResult,
                                            Integer maxResults,
                                            String batchId,
                                            String type,
                                            String tenantIdIn,
                                            Boolean withoutTenantId,
                                            Boolean suspended,
                                            String createdBy,
                                            Date startedBefore,
                                            Date startedAfter,
                                            Boolean withFailures,
                                            Boolean withoutFailures,
                                            ApiCallback<List<BatchStatisticsDto>> _callback)
                                     throws ApiException
        Get Statistics (asynchronously) Queries for batch statistics 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 Batch Statistics Count](https://docs.camunda.org/manual/7.18/reference/rest/batch/get-statistics-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)
        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)
        tenantIdIn - Filter by a comma-separated list of `Strings`. 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)
        suspended - A `Boolean` value which indicates whether only active or suspended batches should be included. When the value is set to `true`, only suspended batches will be returned and when the value is set to `false`, only active batches will be returned. (optional)
        createdBy - Only include batches that were started by this user id. (optional)
        startedBefore - Only include batches that were started before the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)
        startedAfter - Only include batches that were started after the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)
        withFailures - Only include batches having jobs with failures. Value can only be `true`. (optional)
        withoutFailures - Only include batches having jobs without failures. Value can only be `true`. (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

      • getBatchStatisticsCountCall

        public okhttp3.Call getBatchStatisticsCountCall​(String batchId,
                                                String type,
                                                String tenantIdIn,
                                                Boolean withoutTenantId,
                                                Boolean suspended,
                                                String createdBy,
                                                Date startedBefore,
                                                Date startedAfter,
                                                Boolean withFailures,
                                                Boolean withoutFailures,
                                                ApiCallback _callback)
                                         throws ApiException
        Build call for getBatchStatisticsCount
        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)
        tenantIdIn - Filter by a comma-separated list of `Strings`. 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)
        suspended - A `Boolean` value which indicates whether only active or suspended batches should be included. When the value is set to `true`, only suspended batches will be returned and when the value is set to `false`, only active batches will be returned. (optional)
        createdBy - Only include batches that were started by this user id. (optional)
        startedBefore - Only include batches that were started before the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)
        startedAfter - Only include batches that were started after the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)
        withFailures - Only include batches having jobs with failures. Value can only be `true`. (optional)
        withoutFailures - Only include batches having jobs without failures. Value can only be `true`. (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getBatchStatisticsCount

        public CountResultDto getBatchStatisticsCount​(String batchId,
                                              String type,
                                              String tenantIdIn,
                                              Boolean withoutTenantId,
                                              Boolean suspended,
                                              String createdBy,
                                              Date startedBefore,
                                              Date startedAfter,
                                              Boolean withFailures,
                                              Boolean withoutFailures)
                                       throws ApiException
        Get Statistics Count Requests the number of batch statistics that fulfill the query criteria. Takes the same filtering parameters as the [Get Batch Statistics](https://docs.camunda.org/manual/7.18/reference/rest/batch/get-statistics-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)
        tenantIdIn - Filter by a comma-separated list of `Strings`. 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)
        suspended - A `Boolean` value which indicates whether only active or suspended batches should be included. When the value is set to `true`, only suspended batches will be returned and when the value is set to `false`, only active batches will be returned. (optional)
        createdBy - Only include batches that were started by this user id. (optional)
        startedBefore - Only include batches that were started before the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)
        startedAfter - Only include batches that were started after the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)
        withFailures - Only include batches having jobs with failures. Value can only be `true`. (optional)
        withoutFailures - Only include batches having jobs without failures. Value can only be `true`. (optional)
        Returns:
        CountResultDto
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getBatchStatisticsCountWithHttpInfo

        public ApiResponse<CountResultDto> getBatchStatisticsCountWithHttpInfo​(String batchId,
                                                                       String type,
                                                                       String tenantIdIn,
                                                                       Boolean withoutTenantId,
                                                                       Boolean suspended,
                                                                       String createdBy,
                                                                       Date startedBefore,
                                                                       Date startedAfter,
                                                                       Boolean withFailures,
                                                                       Boolean withoutFailures)
                                                                throws ApiException
        Get Statistics Count Requests the number of batch statistics that fulfill the query criteria. Takes the same filtering parameters as the [Get Batch Statistics](https://docs.camunda.org/manual/7.18/reference/rest/batch/get-statistics-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)
        tenantIdIn - Filter by a comma-separated list of `Strings`. 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)
        suspended - A `Boolean` value which indicates whether only active or suspended batches should be included. When the value is set to `true`, only suspended batches will be returned and when the value is set to `false`, only active batches will be returned. (optional)
        createdBy - Only include batches that were started by this user id. (optional)
        startedBefore - Only include batches that were started before the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)
        startedAfter - Only include batches that were started after the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)
        withFailures - Only include batches having jobs with failures. Value can only be `true`. (optional)
        withoutFailures - Only include batches having jobs without failures. Value can only be `true`. (optional)
        Returns:
        ApiResponse<CountResultDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getBatchStatisticsCountAsync

        public okhttp3.Call getBatchStatisticsCountAsync​(String batchId,
                                                 String type,
                                                 String tenantIdIn,
                                                 Boolean withoutTenantId,
                                                 Boolean suspended,
                                                 String createdBy,
                                                 Date startedBefore,
                                                 Date startedAfter,
                                                 Boolean withFailures,
                                                 Boolean withoutFailures,
                                                 ApiCallback<CountResultDto> _callback)
                                          throws ApiException
        Get Statistics Count (asynchronously) Requests the number of batch statistics that fulfill the query criteria. Takes the same filtering parameters as the [Get Batch Statistics](https://docs.camunda.org/manual/7.18/reference/rest/batch/get-statistics-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)
        tenantIdIn - Filter by a comma-separated list of `Strings`. 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)
        suspended - A `Boolean` value which indicates whether only active or suspended batches should be included. When the value is set to `true`, only suspended batches will be returned and when the value is set to `false`, only active batches will be returned. (optional)
        createdBy - Only include batches that were started by this user id. (optional)
        startedBefore - Only include batches that were started before the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)
        startedAfter - Only include batches that were started after the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)
        withFailures - Only include batches having jobs with failures. Value can only be `true`. (optional)
        withoutFailures - Only include batches having jobs without failures. Value can only be `true`. (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

      • getBatchesCall

        public okhttp3.Call getBatchesCall​(String sortBy,
                                   String sortOrder,
                                   Integer firstResult,
                                   Integer maxResults,
                                   String batchId,
                                   String type,
                                   String tenantIdIn,
                                   Boolean withoutTenantId,
                                   Boolean suspended,
                                   String createdBy,
                                   Date startedBefore,
                                   Date startedAfter,
                                   Boolean withFailures,
                                   Boolean withoutFailures,
                                   ApiCallback _callback)
                            throws ApiException
        Build call for getBatches
        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)
        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)
        tenantIdIn - Filter by a comma-separated list of `Strings`. 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)
        suspended - A `Boolean` value which indicates whether only active or suspended batches should be included. When the value is set to `true`, only suspended batches will be returned and when the value is set to `false`, only active batches will be returned. (optional)
        createdBy - Only include batches that were started by this user id. (optional)
        startedBefore - Only include batches that were started before the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)
        startedAfter - Only include batches that were started after the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)
        withFailures - Only include batches having jobs with failures. Value can only be `true`. (optional)
        withoutFailures - Only include batches having jobs without failures. Value can only be `true`. (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getBatches

        public List<BatchDto> getBatches​(String sortBy,
                                 String sortOrder,
                                 Integer firstResult,
                                 Integer maxResults,
                                 String batchId,
                                 String type,
                                 String tenantIdIn,
                                 Boolean withoutTenantId,
                                 Boolean suspended,
                                 String createdBy,
                                 Date startedBefore,
                                 Date startedAfter,
                                 Boolean withFailures,
                                 Boolean withoutFailures)
                          throws ApiException
        Get List Queries for 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 Batch Count](https://docs.camunda.org/manual/7.18/reference/rest/batch/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)
        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)
        tenantIdIn - Filter by a comma-separated list of `Strings`. 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)
        suspended - A `Boolean` value which indicates whether only active or suspended batches should be included. When the value is set to `true`, only suspended batches will be returned and when the value is set to `false`, only active batches will be returned. (optional)
        createdBy - Only include batches that were started by this user id. (optional)
        startedBefore - Only include batches that were started before the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)
        startedAfter - Only include batches that were started after the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)
        withFailures - Only include batches having jobs with failures. Value can only be `true`. (optional)
        withoutFailures - Only include batches having jobs without failures. Value can only be `true`. (optional)
        Returns:
        List<BatchDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getBatchesWithHttpInfo

        public ApiResponse<List<BatchDto>> getBatchesWithHttpInfo​(String sortBy,
                                                          String sortOrder,
                                                          Integer firstResult,
                                                          Integer maxResults,
                                                          String batchId,
                                                          String type,
                                                          String tenantIdIn,
                                                          Boolean withoutTenantId,
                                                          Boolean suspended,
                                                          String createdBy,
                                                          Date startedBefore,
                                                          Date startedAfter,
                                                          Boolean withFailures,
                                                          Boolean withoutFailures)
                                                   throws ApiException
        Get List Queries for 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 Batch Count](https://docs.camunda.org/manual/7.18/reference/rest/batch/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)
        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)
        tenantIdIn - Filter by a comma-separated list of `Strings`. 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)
        suspended - A `Boolean` value which indicates whether only active or suspended batches should be included. When the value is set to `true`, only suspended batches will be returned and when the value is set to `false`, only active batches will be returned. (optional)
        createdBy - Only include batches that were started by this user id. (optional)
        startedBefore - Only include batches that were started before the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)
        startedAfter - Only include batches that were started after the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)
        withFailures - Only include batches having jobs with failures. Value can only be `true`. (optional)
        withoutFailures - Only include batches having jobs without failures. Value can only be `true`. (optional)
        Returns:
        ApiResponse<List<BatchDto>>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getBatchesAsync

        public okhttp3.Call getBatchesAsync​(String sortBy,
                                    String sortOrder,
                                    Integer firstResult,
                                    Integer maxResults,
                                    String batchId,
                                    String type,
                                    String tenantIdIn,
                                    Boolean withoutTenantId,
                                    Boolean suspended,
                                    String createdBy,
                                    Date startedBefore,
                                    Date startedAfter,
                                    Boolean withFailures,
                                    Boolean withoutFailures,
                                    ApiCallback<List<BatchDto>> _callback)
                             throws ApiException
        Get List (asynchronously) Queries for 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 Batch Count](https://docs.camunda.org/manual/7.18/reference/rest/batch/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)
        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)
        tenantIdIn - Filter by a comma-separated list of `Strings`. 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)
        suspended - A `Boolean` value which indicates whether only active or suspended batches should be included. When the value is set to `true`, only suspended batches will be returned and when the value is set to `false`, only active batches will be returned. (optional)
        createdBy - Only include batches that were started by this user id. (optional)
        startedBefore - Only include batches that were started before the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)
        startedAfter - Only include batches that were started after the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)
        withFailures - Only include batches having jobs with failures. Value can only be `true`. (optional)
        withoutFailures - Only include batches having jobs without failures. Value can only be `true`. (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

      • getBatchesCountCall

        public okhttp3.Call getBatchesCountCall​(String batchId,
                                        String type,
                                        String tenantIdIn,
                                        Boolean withoutTenantId,
                                        Boolean suspended,
                                        String createdBy,
                                        Date startedBefore,
                                        Date startedAfter,
                                        Boolean withFailures,
                                        Boolean withoutFailures,
                                        ApiCallback _callback)
                                 throws ApiException
        Build call for getBatchesCount
        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)
        tenantIdIn - Filter by a comma-separated list of `Strings`. 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)
        suspended - A `Boolean` value which indicates whether only active or suspended batches should be included. When the value is set to `true`, only suspended batches will be returned and when the value is set to `false`, only active batches will be returned. (optional)
        createdBy - Only include batches that were started by this user id. (optional)
        startedBefore - Only include batches that were started before the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)
        startedAfter - Only include batches that were started after the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)
        withFailures - Only include batches having jobs with failures. Value can only be `true`. (optional)
        withoutFailures - Only include batches having jobs without failures. Value can only be `true`. (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getBatchesCount

        public CountResultDto getBatchesCount​(String batchId,
                                      String type,
                                      String tenantIdIn,
                                      Boolean withoutTenantId,
                                      Boolean suspended,
                                      String createdBy,
                                      Date startedBefore,
                                      Date startedAfter,
                                      Boolean withFailures,
                                      Boolean withoutFailures)
                               throws ApiException
        Get List Count Requests the number of batches that fulfill the query criteria. Takes the same filtering parameters as the [Get Batches](https://docs.camunda.org/manual/7.18/reference/rest/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)
        tenantIdIn - Filter by a comma-separated list of `Strings`. 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)
        suspended - A `Boolean` value which indicates whether only active or suspended batches should be included. When the value is set to `true`, only suspended batches will be returned and when the value is set to `false`, only active batches will be returned. (optional)
        createdBy - Only include batches that were started by this user id. (optional)
        startedBefore - Only include batches that were started before the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)
        startedAfter - Only include batches that were started after the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)
        withFailures - Only include batches having jobs with failures. Value can only be `true`. (optional)
        withoutFailures - Only include batches having jobs without failures. Value can only be `true`. (optional)
        Returns:
        CountResultDto
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getBatchesCountWithHttpInfo

        public ApiResponse<CountResultDto> getBatchesCountWithHttpInfo​(String batchId,
                                                               String type,
                                                               String tenantIdIn,
                                                               Boolean withoutTenantId,
                                                               Boolean suspended,
                                                               String createdBy,
                                                               Date startedBefore,
                                                               Date startedAfter,
                                                               Boolean withFailures,
                                                               Boolean withoutFailures)
                                                        throws ApiException
        Get List Count Requests the number of batches that fulfill the query criteria. Takes the same filtering parameters as the [Get Batches](https://docs.camunda.org/manual/7.18/reference/rest/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)
        tenantIdIn - Filter by a comma-separated list of `Strings`. 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)
        suspended - A `Boolean` value which indicates whether only active or suspended batches should be included. When the value is set to `true`, only suspended batches will be returned and when the value is set to `false`, only active batches will be returned. (optional)
        createdBy - Only include batches that were started by this user id. (optional)
        startedBefore - Only include batches that were started before the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)
        startedAfter - Only include batches that were started after the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)
        withFailures - Only include batches having jobs with failures. Value can only be `true`. (optional)
        withoutFailures - Only include batches having jobs without failures. Value can only be `true`. (optional)
        Returns:
        ApiResponse<CountResultDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getBatchesCountAsync

        public okhttp3.Call getBatchesCountAsync​(String batchId,
                                         String type,
                                         String tenantIdIn,
                                         Boolean withoutTenantId,
                                         Boolean suspended,
                                         String createdBy,
                                         Date startedBefore,
                                         Date startedAfter,
                                         Boolean withFailures,
                                         Boolean withoutFailures,
                                         ApiCallback<CountResultDto> _callback)
                                  throws ApiException
        Get List Count (asynchronously) Requests the number of batches that fulfill the query criteria. Takes the same filtering parameters as the [Get Batches](https://docs.camunda.org/manual/7.18/reference/rest/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)
        tenantIdIn - Filter by a comma-separated list of `Strings`. 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)
        suspended - A `Boolean` value which indicates whether only active or suspended batches should be included. When the value is set to `true`, only suspended batches will be returned and when the value is set to `false`, only active batches will be returned. (optional)
        createdBy - Only include batches that were started by this user id. (optional)
        startedBefore - Only include batches that were started before the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)
        startedAfter - Only include batches that were started after the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)
        withFailures - Only include batches having jobs with failures. Value can only be `true`. (optional)
        withoutFailures - Only include batches having jobs without failures. Value can only be `true`. (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

      • updateBatchSuspensionStateCall

        public okhttp3.Call updateBatchSuspensionStateCall​(String id,
                                                   SuspensionStateDto suspensionStateDto,
                                                   ApiCallback _callback)
                                            throws ApiException
        Build call for updateBatchSuspensionState
        Parameters:
        id - The id of the batch to activate or suspend. (required)
        suspensionStateDto - (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • updateBatchSuspensionState

        public void updateBatchSuspensionState​(String id,
                                       SuspensionStateDto suspensionStateDto)
                                throws ApiException
        Activate/Suspend Activates or suspends a batch by id.
        Parameters:
        id - The id of the batch to activate or suspend. (required)
        suspensionStateDto - (optional)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • updateBatchSuspensionStateWithHttpInfo

        public ApiResponse<Void> updateBatchSuspensionStateWithHttpInfo​(String id,
                                                                SuspensionStateDto suspensionStateDto)
                                                         throws ApiException
        Activate/Suspend Activates or suspends a batch by id.
        Parameters:
        id - The id of the batch to activate or suspend. (required)
        suspensionStateDto - (optional)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • updateBatchSuspensionStateAsync

        public okhttp3.Call updateBatchSuspensionStateAsync​(String id,
                                                    SuspensionStateDto suspensionStateDto,
                                                    ApiCallback<Void> _callback)
                                             throws ApiException
        Activate/Suspend (asynchronously) Activates or suspends a batch by id.
        Parameters:
        id - The id of the batch to activate or suspend. (required)
        suspensionStateDto - (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