Package org.openapitools.client.api

Class FilterApi

  • public class FilterApi
extends Object

    • Constructor Detail

      • FilterApi

        public FilterApi()

      • FilterApi

        public FilterApi​(ApiClient apiClient)

    • Method Detail

      • getApiClient

        public ApiClient getApiClient()

      • setApiClient

        public void setApiClient​(ApiClient apiClient)

      • createFilterCall

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

      • createFilter

        public FilterDto createFilter​(CreateFilterDto createFilterDto)
                       throws ApiException
        Create Filter Creates a new filter.
        Parameters:
        createFilterDto - (optional)
        Returns:
        FilterDto
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • createFilterWithHttpInfo

        public ApiResponse<FilterDto> createFilterWithHttpInfo​(CreateFilterDto createFilterDto)
                                                throws ApiException
        Create Filter Creates a new filter.
        Parameters:
        createFilterDto - (optional)
        Returns:
        ApiResponse<FilterDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • createFilterAsync

        public okhttp3.Call createFilterAsync​(CreateFilterDto createFilterDto,
                                      ApiCallback<FilterDto> _callback)
                               throws ApiException
        Create Filter (asynchronously) Creates a new filter.
        Parameters:
        createFilterDto - (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

      • deleteFilterCall

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

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

      • deleteFilterWithHttpInfo

        public ApiResponse<Void> deleteFilterWithHttpInfo​(String id)
                                           throws ApiException
        Delete Filter Deletes a filter by id.
        Parameters:
        id - The id of the filter to be deleted. (required)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • deleteFilterAsync

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

      • executeFilterCountCall

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

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

      • executeFilterCountWithHttpInfo

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

      • executeFilterCountAsync

        public okhttp3.Call executeFilterCountAsync​(String id,
                                            ApiCallback<CountResultDto> _callback)
                                     throws ApiException
        Execute Filter Count (asynchronously) Executes the saved query of the filter by id and returns the count.
        Parameters:
        id - The id of the filter to execute. (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

      • executeFilterListCall

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

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

      • executeFilterListWithHttpInfo

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

      • executeFilterListAsync

        public okhttp3.Call executeFilterListAsync​(String id,
                                           Integer firstResult,
                                           Integer maxResults,
                                           ApiCallback<List<Object>> _callback)
                                    throws ApiException
        Execute Filter List (asynchronously) 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)
        _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

      • executeFilterSingleResultCall

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

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

      • executeFilterSingleResultWithHttpInfo

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

      • executeFilterSingleResultAsync

        public okhttp3.Call executeFilterSingleResultAsync​(String id,
                                                   ApiCallback<Object> _callback)
                                            throws ApiException
        Execute Filter Single Result (asynchronously) Executes the saved query of the filter by id and returns the single result.
        Parameters:
        id - The id of the filter to execute. (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

      • filterResourceOptionsCall

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

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

      • filterResourceOptionsWithHttpInfo

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

      • filterResourceOptionsAsync

        public okhttp3.Call filterResourceOptionsAsync​(ApiCallback<ResourceOptionsDto> _callback)
                                        throws ApiException
        Filter Resource Options (asynchronously) 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:
        _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

      • filterResourceOptionsSingleCall

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

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

      • filterResourceOptionsSingleWithHttpInfo

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

      • filterResourceOptionsSingleAsync

        public okhttp3.Call filterResourceOptionsSingleAsync​(String id,
                                                     ApiCallback<ResourceOptionsDto> _callback)
                                              throws ApiException
        Filter Resource Options (asynchronously) 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)
        _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

      • getFilterCountCall

        public okhttp3.Call getFilterCountCall​(String filterId,
                                       String resourceType,
                                       String name,
                                       String nameLike,
                                       String owner,
                                       ApiCallback _callback)
                                throws ApiException
        Build call for getFilterCount
        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)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

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

      • getFilterCountWithHttpInfo

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

      • getFilterCountAsync

        public okhttp3.Call getFilterCountAsync​(String filterId,
                                        String resourceType,
                                        String name,
                                        String nameLike,
                                        String owner,
                                        ApiCallback<CountResultDto> _callback)
                                 throws ApiException
        Get Filter Count (asynchronously) 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.18/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)
        _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

      • getFilterListCall

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

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

      • getFilterListWithHttpInfo

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

      • getFilterListAsync

        public okhttp3.Call getFilterListAsync​(String filterId,
                                       String resourceType,
                                       String name,
                                       String nameLike,
                                       String owner,
                                       Boolean itemCount,
                                       String sortBy,
                                       String sortOrder,
                                       Integer firstResult,
                                       Integer maxResults,
                                       ApiCallback<List<FilterDto>> _callback)
                                throws ApiException
        Get Filters (asynchronously) 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.18/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)
        _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

      • getSingleFilterCall

        public okhttp3.Call getSingleFilterCall​(String id,
                                        Boolean itemCount,
                                        ApiCallback _callback)
                                 throws ApiException
        Build call for getSingleFilter
        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)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

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

      • getSingleFilterWithHttpInfo

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

      • getSingleFilterAsync

        public okhttp3.Call getSingleFilterAsync​(String id,
                                         Boolean itemCount,
                                         ApiCallback<FilterDto> _callback)
                                  throws ApiException
        Get Single Filter (asynchronously) 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)
        _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

      • postExecuteFilterCountCall

        public okhttp3.Call postExecuteFilterCountCall​(String id,
                                               Object body,
                                               ApiCallback _callback)
                                        throws ApiException
        Build call for postExecuteFilterCount
        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)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

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

      • postExecuteFilterCountWithHttpInfo

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

      • postExecuteFilterCountAsync

        public okhttp3.Call postExecuteFilterCountAsync​(String id,
                                                Object body,
                                                ApiCallback<CountResultDto> _callback)
                                         throws ApiException
        Execute Filter Count (POST) (asynchronously) 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.18/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)
        _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

      • postExecuteFilterListCall

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

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

      • postExecuteFilterListWithHttpInfo

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

      • postExecuteFilterListAsync

        public okhttp3.Call postExecuteFilterListAsync​(String id,
                                               Integer firstResult,
                                               Integer maxResults,
                                               Object body,
                                               ApiCallback<List<Object>> _callback)
                                        throws ApiException
        Execute Filter List (POST) (asynchronously) 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.18/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)
        _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

      • postExecuteFilterSingleResultCall

        public okhttp3.Call postExecuteFilterSingleResultCall​(String id,
                                                      Object body,
                                                      ApiCallback _callback)
                                               throws ApiException
        Build call for postExecuteFilterSingleResult
        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)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

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

      • postExecuteFilterSingleResultWithHttpInfo

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

      • postExecuteFilterSingleResultAsync

        public okhttp3.Call postExecuteFilterSingleResultAsync​(String id,
                                                       Object body,
                                                       ApiCallback<Object> _callback)
                                                throws ApiException
        Execute Filter Single Result (POST) (asynchronously) 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.18/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)
        _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

      • updateFilterCall

        public okhttp3.Call updateFilterCall​(String id,
                                     CreateFilterDto createFilterDto,
                                     ApiCallback _callback)
                              throws ApiException
        Build call for updateFilter
        Parameters:
        id - The id of the filter to be updated. (required)
        createFilterDto - (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

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

      • updateFilterWithHttpInfo

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

      • updateFilterAsync

        public okhttp3.Call updateFilterAsync​(String id,
                                      CreateFilterDto createFilterDto,
                                      ApiCallback<Void> _callback)
                               throws ApiException
        Update Filter (asynchronously) Updates an existing filter.
        Parameters:
        id - The id of the filter to be updated. (required)
        createFilterDto - (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