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

Class BatchApi

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

  • Constructor Details

    • BatchApi

      public BatchApi()

    • BatchApi

      public BatchApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • 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 fails to make API call

    • deleteBatch

      public void deleteBatch(String id, Boolean cascade, Map<String,String> additionalHeaders) 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)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • 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 fails to make API call

    • getBatch

      public BatchDto getBatch(String id, Map<String,String> additionalHeaders) 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)
      additionalHeaders - additionalHeaders for this call
      Returns:
      BatchDto
      Throws:
      ApiException - if fails to make API call

    • 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, OffsetDateTime startedBefore, OffsetDateTime 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.21/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.21/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.21/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.21/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 fails to make API call

    • 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, OffsetDateTime startedBefore, OffsetDateTime startedAfter, Boolean withFailures, Boolean withoutFailures, Map<String,String> additionalHeaders) 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.21/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.21/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.21/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.21/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)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<BatchStatisticsDto>
      Throws:
      ApiException - if fails to make API call

    • getBatchStatisticsCount

      public CountResultDto getBatchStatisticsCount(String batchId, String type, String tenantIdIn, Boolean withoutTenantId, Boolean suspended, String createdBy, OffsetDateTime startedBefore, OffsetDateTime 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.21/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.21/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.21/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.21/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 fails to make API call

    • getBatchStatisticsCount

      public CountResultDto getBatchStatisticsCount(String batchId, String type, String tenantIdIn, Boolean withoutTenantId, Boolean suspended, String createdBy, OffsetDateTime startedBefore, OffsetDateTime startedAfter, Boolean withFailures, Boolean withoutFailures, Map<String,String> additionalHeaders) 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.21/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.21/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.21/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.21/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)
      additionalHeaders - additionalHeaders for this call
      Returns:
      CountResultDto
      Throws:
      ApiException - if fails to make API call

    • 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, OffsetDateTime startedBefore, OffsetDateTime 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.21/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.21/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.21/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.21/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 fails to make API call

    • 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, OffsetDateTime startedBefore, OffsetDateTime startedAfter, Boolean withFailures, Boolean withoutFailures, Map<String,String> additionalHeaders) 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.21/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.21/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.21/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.21/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)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<BatchDto>
      Throws:
      ApiException - if fails to make API call

    • getBatchesCount

      public CountResultDto getBatchesCount(String batchId, String type, String tenantIdIn, Boolean withoutTenantId, Boolean suspended, String createdBy, OffsetDateTime startedBefore, OffsetDateTime 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.21/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.21/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.21/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.21/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 fails to make API call

    • getBatchesCount

      public CountResultDto getBatchesCount(String batchId, String type, String tenantIdIn, Boolean withoutTenantId, Boolean suspended, String createdBy, OffsetDateTime startedBefore, OffsetDateTime startedAfter, Boolean withFailures, Boolean withoutFailures, Map<String,String> additionalHeaders) 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.21/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.21/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.21/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.21/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)
      additionalHeaders - additionalHeaders for this call
      Returns:
      CountResultDto
      Throws:
      ApiException - if fails to make API call

    • 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 fails to make API call

    • updateBatchSuspensionState

      public void updateBatchSuspensionState(String id, SuspensionStateDto suspensionStateDto, Map<String,String> additionalHeaders) 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)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call