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

Class FilterApi

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

  • Constructor Details

    • FilterApi

      public FilterApi()

    • FilterApi

      public FilterApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • createFilter

      public FilterDto createFilter(CreateFilterDto createFilterDto) throws ApiException
      Create Filter Creates a new filter.
      Parameters:
      createFilterDto - (optional)
      Returns:
      FilterDto
      Throws:
      ApiException - if fails to make API call

    • createFilter

      public FilterDto createFilter(CreateFilterDto createFilterDto, Map<String,String> additionalHeaders) throws ApiException
      Create Filter Creates a new filter.
      Parameters:
      createFilterDto - (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      FilterDto
      Throws:
      ApiException - if fails to make API call

    • deleteFilter

      public void deleteFilter(String id) throws ApiException
      Delete Filter Deletes a filter by id.
      Parameters:
      id - The id of the filter to be deleted. (required)
      Throws:
      ApiException - if fails to make API call

    • deleteFilter

      public void deleteFilter(String id, Map<String,String> additionalHeaders) throws ApiException
      Delete Filter Deletes a filter by id.
      Parameters:
      id - The id of the filter to be deleted. (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • executeFilterCount

      public CountResultDto executeFilterCount(String id) throws ApiException
      Execute Filter Count Executes the saved query of the filter by id and returns the count.
      Parameters:
      id - The id of the filter to execute. (required)
      Returns:
      CountResultDto
      Throws:
      ApiException - if fails to make API call

    • executeFilterCount

      public CountResultDto executeFilterCount(String id, Map<String,String> additionalHeaders) throws ApiException
      Execute Filter Count Executes the saved query of the filter by id and returns the count.
      Parameters:
      id - The id of the filter to execute. (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      CountResultDto
      Throws:
      ApiException - if fails to make API call

    • executeFilterList

      public List<Object> executeFilterList(String id, Integer firstResult, Integer maxResults) throws ApiException
      Execute Filter List Executes the saved query of the filter by id and returns the result list.
      Parameters:
      id - The id of the filter to execute. (required)
      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<Object>
      Throws:
      ApiException - if fails to make API call

    • executeFilterList

      public List<Object> executeFilterList(String id, Integer firstResult, Integer maxResults, Map<String,String> additionalHeaders) throws ApiException
      Execute Filter List Executes the saved query of the filter by id and returns the result list.
      Parameters:
      id - The id of the filter to execute. (required)
      firstResult - Pagination of results. Specifies the index of the first result to return. (optional)
      maxResults - Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<Object>
      Throws:
      ApiException - if fails to make API call

    • executeFilterSingleResult

      public Object executeFilterSingleResult(String id) throws ApiException
      Execute Filter Single Result Executes the saved query of the filter by id and returns the single result.
      Parameters:
      id - The id of the filter to execute. (required)
      Returns:
      Object
      Throws:
      ApiException - if fails to make API call

    • executeFilterSingleResult

      public Object executeFilterSingleResult(String id, Map<String,String> additionalHeaders) throws ApiException
      Execute Filter Single Result Executes the saved query of the filter by id and returns the single result.
      Parameters:
      id - The id of the filter to execute. (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      Object
      Throws:
      ApiException - if fails to make API call

    • filterResourceOptions

      public ResourceOptionsDto filterResourceOptions() throws ApiException
      Filter Resource Options The OPTIONS request allows you to check for the set of available operations that the currently authenticated user can perform on the `/filter` resource. Whether the user can perform an operation or not may depend on various factors, including the users authorizations to interact with this resource and the internal configuration of the process engine.
      Returns:
      ResourceOptionsDto
      Throws:
      ApiException - if fails to make API call

    • filterResourceOptions

      public ResourceOptionsDto filterResourceOptions(Map<String,String> additionalHeaders) throws ApiException
      Filter Resource Options The OPTIONS request allows you to check for the set of available operations that the currently authenticated user can perform on the `/filter` resource. Whether the user can perform an operation or not may depend on various factors, including the users authorizations to interact with this resource and the internal configuration of the process engine.
      Parameters:
      additionalHeaders - additionalHeaders for this call
      Returns:
      ResourceOptionsDto
      Throws:
      ApiException - if fails to make API call

    • filterResourceOptionsSingle

      public ResourceOptionsDto filterResourceOptionsSingle(String id) throws ApiException
      Filter Resource Options The OPTIONS request allows you to check for the set of available operations that the currently authenticated user can perform on the `/filter` resource. Whether the user can perform an operation or not may depend on various factors, including the users authorizations to interact with this resource and the internal configuration of the process engine.
      Parameters:
      id - The id of the filter to be checked. (required)
      Returns:
      ResourceOptionsDto
      Throws:
      ApiException - if fails to make API call

    • filterResourceOptionsSingle

      public ResourceOptionsDto filterResourceOptionsSingle(String id, Map<String,String> additionalHeaders) throws ApiException
      Filter Resource Options The OPTIONS request allows you to check for the set of available operations that the currently authenticated user can perform on the `/filter` resource. Whether the user can perform an operation or not may depend on various factors, including the users authorizations to interact with this resource and the internal configuration of the process engine.
      Parameters:
      id - The id of the filter to be checked. (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      ResourceOptionsDto
      Throws:
      ApiException - if fails to make API call

    • getFilterCount

      public CountResultDto getFilterCount(String filterId, String resourceType, String name, String nameLike, String owner) throws ApiException
      Get Filter Count Retrieves the number of filters that fulfill a provided query. Corresponds to the size of the result set when using the [Get Filters](https://docs.camunda.org/manual/7.21/reference/rest/filter/get-query/) method.
      Parameters:
      filterId - Filter by the id of the filter. (optional)
      resourceType - Filter by the resource type of the filter, e.g., `Task`. (optional)
      name - Filter by the name of the filter. (optional)
      nameLike - Filter by the name that the parameter is a substring of. (optional)
      owner - Filter by the user id of the owner of the filter. (optional)
      Returns:
      CountResultDto
      Throws:
      ApiException - if fails to make API call

    • getFilterCount

      public CountResultDto getFilterCount(String filterId, String resourceType, String name, String nameLike, String owner, Map<String,String> additionalHeaders) throws ApiException
      Get Filter Count Retrieves the number of filters that fulfill a provided query. Corresponds to the size of the result set when using the [Get Filters](https://docs.camunda.org/manual/7.21/reference/rest/filter/get-query/) method.
      Parameters:
      filterId - Filter by the id of the filter. (optional)
      resourceType - Filter by the resource type of the filter, e.g., `Task`. (optional)
      name - Filter by the name of the filter. (optional)
      nameLike - Filter by the name that the parameter is a substring of. (optional)
      owner - Filter by the user id of the owner of the filter. (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      CountResultDto
      Throws:
      ApiException - if fails to make API call

    • getFilterList

      public List<FilterDto> getFilterList(String filterId, String resourceType, String name, String nameLike, String owner, Boolean itemCount, String sortBy, String sortOrder, Integer firstResult, Integer maxResults) throws ApiException
      Get Filters Queries for a list of filters using a list of parameters. The size of the result set can be retrieved by using the [Get Filter Count](https://docs.camunda.org/manual/7.21/reference/rest/filter/get-query-count/) method.
      Parameters:
      filterId - Filter by the id of the filter. (optional)
      resourceType - Filter by the resource type of the filter, e.g., `Task`. (optional)
      name - Filter by the name of the filter. (optional)
      nameLike - Filter by the name that the parameter is a substring of. (optional)
      owner - Filter by the user id of the owner of the filter. (optional)
      itemCount - If set to `true`, each filter result will contain an `itemCount` property with the number of items matched by the filter itself. (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<FilterDto>
      Throws:
      ApiException - if fails to make API call

    • getFilterList

      public List<FilterDto> getFilterList(String filterId, String resourceType, String name, String nameLike, String owner, Boolean itemCount, String sortBy, String sortOrder, Integer firstResult, Integer maxResults, Map<String,String> additionalHeaders) throws ApiException
      Get Filters Queries for a list of filters using a list of parameters. The size of the result set can be retrieved by using the [Get Filter Count](https://docs.camunda.org/manual/7.21/reference/rest/filter/get-query-count/) method.
      Parameters:
      filterId - Filter by the id of the filter. (optional)
      resourceType - Filter by the resource type of the filter, e.g., `Task`. (optional)
      name - Filter by the name of the filter. (optional)
      nameLike - Filter by the name that the parameter is a substring of. (optional)
      owner - Filter by the user id of the owner of the filter. (optional)
      itemCount - If set to `true`, each filter result will contain an `itemCount` property with the number of items matched by the filter itself. (optional)
      sortBy - Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter. (optional)
      sortOrder - Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter. (optional)
      firstResult - Pagination of results. Specifies the index of the first result to return. (optional)
      maxResults - Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<FilterDto>
      Throws:
      ApiException - if fails to make API call

    • getSingleFilter

      public FilterDto getSingleFilter(String id, Boolean itemCount) throws ApiException
      Get Single Filter Retrieves a single filter by id, according to the `Filter` interface in the engine.
      Parameters:
      id - The id of the filter to be retrieved. (required)
      itemCount - If set to `true`, each filter result will contain an `itemCount` property with the number of items matched by the filter itself. (optional)
      Returns:
      FilterDto
      Throws:
      ApiException - if fails to make API call

    • getSingleFilter

      public FilterDto getSingleFilter(String id, Boolean itemCount, Map<String,String> additionalHeaders) throws ApiException
      Get Single Filter Retrieves a single filter by id, according to the `Filter` interface in the engine.
      Parameters:
      id - The id of the filter to be retrieved. (required)
      itemCount - If set to `true`, each filter result will contain an `itemCount` property with the number of items matched by the filter itself. (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      FilterDto
      Throws:
      ApiException - if fails to make API call

    • postExecuteFilterCount

      public CountResultDto postExecuteFilterCount(String id, Object body) throws ApiException
      Execute Filter Count (POST) Executes the saved query of the filter by id and returns the count. This method is slightly more powerful then the [Get Execute Filter Count](https://docs.camunda.org/manual/7.21/reference/rest/filter/get-execute-count/) method because it allows to extend the saved query of the filter.
      Parameters:
      id - The id of the filter to execute. (required)
      body - A JSON object which corresponds to the type of the saved query of the filter, i.e., if the resource type of the filter is Task the body should form a valid task query corresponding to the Task resource. (optional)
      Returns:
      CountResultDto
      Throws:
      ApiException - if fails to make API call

    • postExecuteFilterCount

      public CountResultDto postExecuteFilterCount(String id, Object body, Map<String,String> additionalHeaders) throws ApiException
      Execute Filter Count (POST) Executes the saved query of the filter by id and returns the count. This method is slightly more powerful then the [Get Execute Filter Count](https://docs.camunda.org/manual/7.21/reference/rest/filter/get-execute-count/) method because it allows to extend the saved query of the filter.
      Parameters:
      id - The id of the filter to execute. (required)
      body - A JSON object which corresponds to the type of the saved query of the filter, i.e., if the resource type of the filter is Task the body should form a valid task query corresponding to the Task resource. (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      CountResultDto
      Throws:
      ApiException - if fails to make API call

    • postExecuteFilterList

      public List<Object> postExecuteFilterList(String id, Integer firstResult, Integer maxResults, Object body) throws ApiException
      Execute Filter List (POST) Executes the saved query of the filter by id and returns the result list. This method is slightly more powerful then the [Get Execute FilterList](https://docs.camunda.org/manual/7.21/reference/rest/filter/get-execute-list/) method because it allows to extend the saved query of the filter.
      Parameters:
      id - The id of the filter to execute. (required)
      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)
      body - A JSON object which corresponds to the type of the saved query of the filter, i.e., if the resource type of the filter is Task the body should form a valid task query corresponding to the Task resource. (optional)
      Returns:
      List<Object>
      Throws:
      ApiException - if fails to make API call

    • postExecuteFilterList

      public List<Object> postExecuteFilterList(String id, Integer firstResult, Integer maxResults, Object body, Map<String,String> additionalHeaders) throws ApiException
      Execute Filter List (POST) Executes the saved query of the filter by id and returns the result list. This method is slightly more powerful then the [Get Execute FilterList](https://docs.camunda.org/manual/7.21/reference/rest/filter/get-execute-list/) method because it allows to extend the saved query of the filter.
      Parameters:
      id - The id of the filter to execute. (required)
      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)
      body - A JSON object which corresponds to the type of the saved query of the filter, i.e., if the resource type of the filter is Task the body should form a valid task query corresponding to the Task resource. (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<Object>
      Throws:
      ApiException - if fails to make API call

    • postExecuteFilterSingleResult

      public Object postExecuteFilterSingleResult(String id, Object body) throws ApiException
      Execute Filter Single Result (POST) Executes the saved query of the filter by id and returns the single result. This method is slightly more powerful then the [Get Execute Filter Single Result](https://docs.camunda.org/manual/7.21/reference/rest/filter/get-execute-single-result/) method because it allows to extend the saved query of the filter.
      Parameters:
      id - The id of the filter to execute. (required)
      body - A JSON object which corresponds to the type of the saved query of the filter, i.e., if the resource type of the filter is Task the body should form a valid task query corresponding to the Task resource. (optional)
      Returns:
      Object
      Throws:
      ApiException - if fails to make API call

    • postExecuteFilterSingleResult

      public Object postExecuteFilterSingleResult(String id, Object body, Map<String,String> additionalHeaders) throws ApiException
      Execute Filter Single Result (POST) Executes the saved query of the filter by id and returns the single result. This method is slightly more powerful then the [Get Execute Filter Single Result](https://docs.camunda.org/manual/7.21/reference/rest/filter/get-execute-single-result/) method because it allows to extend the saved query of the filter.
      Parameters:
      id - The id of the filter to execute. (required)
      body - A JSON object which corresponds to the type of the saved query of the filter, i.e., if the resource type of the filter is Task the body should form a valid task query corresponding to the Task resource. (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      Object
      Throws:
      ApiException - if fails to make API call

    • updateFilter

      public void updateFilter(String id, CreateFilterDto createFilterDto) throws ApiException
      Update Filter Updates an existing filter.
      Parameters:
      id - The id of the filter to be updated. (required)
      createFilterDto - (optional)
      Throws:
      ApiException - if fails to make API call

    • updateFilter

      public void updateFilter(String id, CreateFilterDto createFilterDto, Map<String,String> additionalHeaders) throws ApiException
      Update Filter Updates an existing filter.
      Parameters:
      id - The id of the filter to be updated. (required)
      createFilterDto - (optional)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call