Package org.openapitools.client.api

Class VariableInstanceApi

  • public class VariableInstanceApi
extends Object

    • Constructor Detail

      • VariableInstanceApi

        public VariableInstanceApi()

      • VariableInstanceApi

        public VariableInstanceApi​(ApiClient apiClient)

    • Method Detail

      • getApiClient

        public ApiClient getApiClient()

      • setApiClient

        public void setApiClient​(ApiClient apiClient)

      • getVariableInstanceCall

        public okhttp3.Call getVariableInstanceCall​(String id,
                                            Boolean deserializeValue,
                                            ApiCallback _callback)
                                     throws ApiException
        Build call for getVariableInstance
        Parameters:
        id - The id of the variable instance. (required)
        deserializeValue - Determines whether serializable variable values (typically variables that store custom Java objects) should be deserialized on server side (default `true`). If set to `true`, a serializable variable will be deserialized on server side and transformed to JSON using [Jackson's](https://github.com/FasterXML/jackson) POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath. If set to `false`, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML. **Note:** While `true` is the default value for reasons of backward compatibility, we recommend setting this parameter to `false` when developing web applications that are independent of the Java process applications deployed to the engine. (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getVariableInstance

        public VariableInstanceDto getVariableInstance​(String id,
                                               Boolean deserializeValue)
                                        throws ApiException
        Get Variable Instance Retrieves a variable by id.
        Parameters:
        id - The id of the variable instance. (required)
        deserializeValue - Determines whether serializable variable values (typically variables that store custom Java objects) should be deserialized on server side (default `true`). If set to `true`, a serializable variable will be deserialized on server side and transformed to JSON using [Jackson's](https://github.com/FasterXML/jackson) POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath. If set to `false`, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML. **Note:** While `true` is the default value for reasons of backward compatibility, we recommend setting this parameter to `false` when developing web applications that are independent of the Java process applications deployed to the engine. (optional)
        Returns:
        VariableInstanceDto
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getVariableInstanceWithHttpInfo

        public ApiResponse<VariableInstanceDto> getVariableInstanceWithHttpInfo​(String id,
                                                                        Boolean deserializeValue)
                                                                 throws ApiException
        Get Variable Instance Retrieves a variable by id.
        Parameters:
        id - The id of the variable instance. (required)
        deserializeValue - Determines whether serializable variable values (typically variables that store custom Java objects) should be deserialized on server side (default `true`). If set to `true`, a serializable variable will be deserialized on server side and transformed to JSON using [Jackson's](https://github.com/FasterXML/jackson) POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath. If set to `false`, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML. **Note:** While `true` is the default value for reasons of backward compatibility, we recommend setting this parameter to `false` when developing web applications that are independent of the Java process applications deployed to the engine. (optional)
        Returns:
        ApiResponse<VariableInstanceDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getVariableInstanceAsync

        public okhttp3.Call getVariableInstanceAsync​(String id,
                                             Boolean deserializeValue,
                                             ApiCallback<VariableInstanceDto> _callback)
                                      throws ApiException
        Get Variable Instance (asynchronously) Retrieves a variable by id.
        Parameters:
        id - The id of the variable instance. (required)
        deserializeValue - Determines whether serializable variable values (typically variables that store custom Java objects) should be deserialized on server side (default `true`). If set to `true`, a serializable variable will be deserialized on server side and transformed to JSON using [Jackson's](https://github.com/FasterXML/jackson) POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath. If set to `false`, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML. **Note:** While `true` is the default value for reasons of backward compatibility, we recommend setting this parameter to `false` when developing web applications that are independent of the Java process applications deployed to the engine. (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

      • getVariableInstanceBinaryCall

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

      • getVariableInstanceBinary

        public File getVariableInstanceBinary​(String id)
                               throws ApiException
        Get Variable Instance (Binary) Retrieves the content of a variable by id. Applicable for byte array and file variables.
        Parameters:
        id - The id of the variable instance. (required)
        Returns:
        File
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getVariableInstanceBinaryWithHttpInfo

        public ApiResponse<File> getVariableInstanceBinaryWithHttpInfo​(String id)
                                                        throws ApiException
        Get Variable Instance (Binary) Retrieves the content of a variable by id. Applicable for byte array and file variables.
        Parameters:
        id - The id of the variable instance. (required)
        Returns:
        ApiResponse<File>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getVariableInstanceBinaryAsync

        public okhttp3.Call getVariableInstanceBinaryAsync​(String id,
                                                   ApiCallback<File> _callback)
                                            throws ApiException
        Get Variable Instance (Binary) (asynchronously) Retrieves the content of a variable by id. Applicable for byte array and file variables.
        Parameters:
        id - The id of the variable instance. (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

      • getVariableInstancesCall

        public okhttp3.Call getVariableInstancesCall​(String variableName,
                                             String variableNameLike,
                                             String processInstanceIdIn,
                                             String executionIdIn,
                                             String caseInstanceIdIn,
                                             String caseExecutionIdIn,
                                             String taskIdIn,
                                             String batchIdIn,
                                             String activityInstanceIdIn,
                                             String tenantIdIn,
                                             String variableValues,
                                             Boolean variableNamesIgnoreCase,
                                             Boolean variableValuesIgnoreCase,
                                             String variableScopeIdIn,
                                             String sortBy,
                                             String sortOrder,
                                             Integer firstResult,
                                             Integer maxResults,
                                             Boolean deserializeValues,
                                             ApiCallback _callback)
                                      throws ApiException
        Build call for getVariableInstances
        Parameters:
        variableName - Filter by variable instance name. (optional)
        variableNameLike - Filter by the variable instance name. The parameter can include the wildcard `%` to express like-strategy such as: starts with (`%`name), ends with (name`%`) or contains (`%`name`%`). (optional)
        processInstanceIdIn - Only include variable instances which belong to one of the passed and comma-separated process instance ids. (optional)
        executionIdIn - Only include variable instances which belong to one of the passed and comma-separated execution ids. (optional)
        caseInstanceIdIn - Only include variable instances which belong to one of the passed and comma-separated case instance ids. (optional)
        caseExecutionIdIn - Only include variable instances which belong to one of the passed and comma-separated case execution ids. (optional)
        taskIdIn - Only include variable instances which belong to one of the passed and comma-separated task ids. (optional)
        batchIdIn - Only include variable instances which belong to one of the passed and comma-separated batch ids. (optional)
        activityInstanceIdIn - Only include variable instances which belong to one of the passed and comma-separated activity instance ids. (optional)
        tenantIdIn - Only include variable instances which belong to one of the passed and comma-separated tenant ids. (optional)
        variableValues - Only include variable instances that have the certain values. Value filtering expressions are comma-separated and are structured as follows: A valid parameter value has the form `key_operator_value`. `key` is the variable name, `operator` is the comparison operator to be used and `value` the variable value. **Note:** Values are always treated as `String` objects on server side. Valid operator values are: `eq` - equal to; `neq` - not equal to; `gt` - greater than; `gteq` - greater than or equal to; `lt` - lower than; `lteq` - lower than or equal to; `like`. `key` and `value` may not contain underscore or comma characters. (optional)
        variableNamesIgnoreCase - Match all variable names provided in `variableValues` case-insensitively. If set to `true` **variableName** and **variablename** are treated as equal. (optional)
        variableValuesIgnoreCase - Match all variable values provided in `variableValues` case-insensitively. If set to `true` **variableValue** and **variablevalue** are treated as equal. (optional)
        variableScopeIdIn - Only include variable instances which belong to one of passed scope ids. (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)
        deserializeValues - Determines whether serializable variable values (typically variables that store custom Java objects) should be deserialized on server side (default `true`). If set to `true`, a serializable variable will be deserialized on server side and transformed to JSON using [Jackson's](https://github.com/FasterXML/jackson) POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath. If set to `false`, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML. **Note:** While `true` is the default value for reasons of backward compatibility, we recommend setting this parameter to `false` when developing web applications that are independent of the Java process applications deployed to the engine. (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getVariableInstances

        public List<VariableInstanceDto> getVariableInstances​(String variableName,
                                                      String variableNameLike,
                                                      String processInstanceIdIn,
                                                      String executionIdIn,
                                                      String caseInstanceIdIn,
                                                      String caseExecutionIdIn,
                                                      String taskIdIn,
                                                      String batchIdIn,
                                                      String activityInstanceIdIn,
                                                      String tenantIdIn,
                                                      String variableValues,
                                                      Boolean variableNamesIgnoreCase,
                                                      Boolean variableValuesIgnoreCase,
                                                      String variableScopeIdIn,
                                                      String sortBy,
                                                      String sortOrder,
                                                      Integer firstResult,
                                                      Integer maxResults,
                                                      Boolean deserializeValues)
                                               throws ApiException
        Get Variable Instances Query for variable instances that fulfill given parameters. Parameters may be the properties of variable instances, such as the name or type. The size of the result set can be retrieved by using the [Get Variable Instance Count](https://docs.camunda.org/manual/7.18/reference/rest/variable-instance/get-query-count/) method.
        Parameters:
        variableName - Filter by variable instance name. (optional)
        variableNameLike - Filter by the variable instance name. The parameter can include the wildcard `%` to express like-strategy such as: starts with (`%`name), ends with (name`%`) or contains (`%`name`%`). (optional)
        processInstanceIdIn - Only include variable instances which belong to one of the passed and comma-separated process instance ids. (optional)
        executionIdIn - Only include variable instances which belong to one of the passed and comma-separated execution ids. (optional)
        caseInstanceIdIn - Only include variable instances which belong to one of the passed and comma-separated case instance ids. (optional)
        caseExecutionIdIn - Only include variable instances which belong to one of the passed and comma-separated case execution ids. (optional)
        taskIdIn - Only include variable instances which belong to one of the passed and comma-separated task ids. (optional)
        batchIdIn - Only include variable instances which belong to one of the passed and comma-separated batch ids. (optional)
        activityInstanceIdIn - Only include variable instances which belong to one of the passed and comma-separated activity instance ids. (optional)
        tenantIdIn - Only include variable instances which belong to one of the passed and comma-separated tenant ids. (optional)
        variableValues - Only include variable instances that have the certain values. Value filtering expressions are comma-separated and are structured as follows: A valid parameter value has the form `key_operator_value`. `key` is the variable name, `operator` is the comparison operator to be used and `value` the variable value. **Note:** Values are always treated as `String` objects on server side. Valid operator values are: `eq` - equal to; `neq` - not equal to; `gt` - greater than; `gteq` - greater than or equal to; `lt` - lower than; `lteq` - lower than or equal to; `like`. `key` and `value` may not contain underscore or comma characters. (optional)
        variableNamesIgnoreCase - Match all variable names provided in `variableValues` case-insensitively. If set to `true` **variableName** and **variablename** are treated as equal. (optional)
        variableValuesIgnoreCase - Match all variable values provided in `variableValues` case-insensitively. If set to `true` **variableValue** and **variablevalue** are treated as equal. (optional)
        variableScopeIdIn - Only include variable instances which belong to one of passed scope ids. (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)
        deserializeValues - Determines whether serializable variable values (typically variables that store custom Java objects) should be deserialized on server side (default `true`). If set to `true`, a serializable variable will be deserialized on server side and transformed to JSON using [Jackson's](https://github.com/FasterXML/jackson) POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath. If set to `false`, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML. **Note:** While `true` is the default value for reasons of backward compatibility, we recommend setting this parameter to `false` when developing web applications that are independent of the Java process applications deployed to the engine. (optional)
        Returns:
        List<VariableInstanceDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getVariableInstancesWithHttpInfo

        public ApiResponse<List<VariableInstanceDto>> getVariableInstancesWithHttpInfo​(String variableName,
                                                                               String variableNameLike,
                                                                               String processInstanceIdIn,
                                                                               String executionIdIn,
                                                                               String caseInstanceIdIn,
                                                                               String caseExecutionIdIn,
                                                                               String taskIdIn,
                                                                               String batchIdIn,
                                                                               String activityInstanceIdIn,
                                                                               String tenantIdIn,
                                                                               String variableValues,
                                                                               Boolean variableNamesIgnoreCase,
                                                                               Boolean variableValuesIgnoreCase,
                                                                               String variableScopeIdIn,
                                                                               String sortBy,
                                                                               String sortOrder,
                                                                               Integer firstResult,
                                                                               Integer maxResults,
                                                                               Boolean deserializeValues)
                                                                        throws ApiException
        Get Variable Instances Query for variable instances that fulfill given parameters. Parameters may be the properties of variable instances, such as the name or type. The size of the result set can be retrieved by using the [Get Variable Instance Count](https://docs.camunda.org/manual/7.18/reference/rest/variable-instance/get-query-count/) method.
        Parameters:
        variableName - Filter by variable instance name. (optional)
        variableNameLike - Filter by the variable instance name. The parameter can include the wildcard `%` to express like-strategy such as: starts with (`%`name), ends with (name`%`) or contains (`%`name`%`). (optional)
        processInstanceIdIn - Only include variable instances which belong to one of the passed and comma-separated process instance ids. (optional)
        executionIdIn - Only include variable instances which belong to one of the passed and comma-separated execution ids. (optional)
        caseInstanceIdIn - Only include variable instances which belong to one of the passed and comma-separated case instance ids. (optional)
        caseExecutionIdIn - Only include variable instances which belong to one of the passed and comma-separated case execution ids. (optional)
        taskIdIn - Only include variable instances which belong to one of the passed and comma-separated task ids. (optional)
        batchIdIn - Only include variable instances which belong to one of the passed and comma-separated batch ids. (optional)
        activityInstanceIdIn - Only include variable instances which belong to one of the passed and comma-separated activity instance ids. (optional)
        tenantIdIn - Only include variable instances which belong to one of the passed and comma-separated tenant ids. (optional)
        variableValues - Only include variable instances that have the certain values. Value filtering expressions are comma-separated and are structured as follows: A valid parameter value has the form `key_operator_value`. `key` is the variable name, `operator` is the comparison operator to be used and `value` the variable value. **Note:** Values are always treated as `String` objects on server side. Valid operator values are: `eq` - equal to; `neq` - not equal to; `gt` - greater than; `gteq` - greater than or equal to; `lt` - lower than; `lteq` - lower than or equal to; `like`. `key` and `value` may not contain underscore or comma characters. (optional)
        variableNamesIgnoreCase - Match all variable names provided in `variableValues` case-insensitively. If set to `true` **variableName** and **variablename** are treated as equal. (optional)
        variableValuesIgnoreCase - Match all variable values provided in `variableValues` case-insensitively. If set to `true` **variableValue** and **variablevalue** are treated as equal. (optional)
        variableScopeIdIn - Only include variable instances which belong to one of passed scope ids. (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)
        deserializeValues - Determines whether serializable variable values (typically variables that store custom Java objects) should be deserialized on server side (default `true`). If set to `true`, a serializable variable will be deserialized on server side and transformed to JSON using [Jackson's](https://github.com/FasterXML/jackson) POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath. If set to `false`, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML. **Note:** While `true` is the default value for reasons of backward compatibility, we recommend setting this parameter to `false` when developing web applications that are independent of the Java process applications deployed to the engine. (optional)
        Returns:
        ApiResponse<List<VariableInstanceDto>>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getVariableInstancesAsync

        public okhttp3.Call getVariableInstancesAsync​(String variableName,
                                              String variableNameLike,
                                              String processInstanceIdIn,
                                              String executionIdIn,
                                              String caseInstanceIdIn,
                                              String caseExecutionIdIn,
                                              String taskIdIn,
                                              String batchIdIn,
                                              String activityInstanceIdIn,
                                              String tenantIdIn,
                                              String variableValues,
                                              Boolean variableNamesIgnoreCase,
                                              Boolean variableValuesIgnoreCase,
                                              String variableScopeIdIn,
                                              String sortBy,
                                              String sortOrder,
                                              Integer firstResult,
                                              Integer maxResults,
                                              Boolean deserializeValues,
                                              ApiCallback<List<VariableInstanceDto>> _callback)
                                       throws ApiException
        Get Variable Instances (asynchronously) Query for variable instances that fulfill given parameters. Parameters may be the properties of variable instances, such as the name or type. The size of the result set can be retrieved by using the [Get Variable Instance Count](https://docs.camunda.org/manual/7.18/reference/rest/variable-instance/get-query-count/) method.
        Parameters:
        variableName - Filter by variable instance name. (optional)
        variableNameLike - Filter by the variable instance name. The parameter can include the wildcard `%` to express like-strategy such as: starts with (`%`name), ends with (name`%`) or contains (`%`name`%`). (optional)
        processInstanceIdIn - Only include variable instances which belong to one of the passed and comma-separated process instance ids. (optional)
        executionIdIn - Only include variable instances which belong to one of the passed and comma-separated execution ids. (optional)
        caseInstanceIdIn - Only include variable instances which belong to one of the passed and comma-separated case instance ids. (optional)
        caseExecutionIdIn - Only include variable instances which belong to one of the passed and comma-separated case execution ids. (optional)
        taskIdIn - Only include variable instances which belong to one of the passed and comma-separated task ids. (optional)
        batchIdIn - Only include variable instances which belong to one of the passed and comma-separated batch ids. (optional)
        activityInstanceIdIn - Only include variable instances which belong to one of the passed and comma-separated activity instance ids. (optional)
        tenantIdIn - Only include variable instances which belong to one of the passed and comma-separated tenant ids. (optional)
        variableValues - Only include variable instances that have the certain values. Value filtering expressions are comma-separated and are structured as follows: A valid parameter value has the form `key_operator_value`. `key` is the variable name, `operator` is the comparison operator to be used and `value` the variable value. **Note:** Values are always treated as `String` objects on server side. Valid operator values are: `eq` - equal to; `neq` - not equal to; `gt` - greater than; `gteq` - greater than or equal to; `lt` - lower than; `lteq` - lower than or equal to; `like`. `key` and `value` may not contain underscore or comma characters. (optional)
        variableNamesIgnoreCase - Match all variable names provided in `variableValues` case-insensitively. If set to `true` **variableName** and **variablename** are treated as equal. (optional)
        variableValuesIgnoreCase - Match all variable values provided in `variableValues` case-insensitively. If set to `true` **variableValue** and **variablevalue** are treated as equal. (optional)
        variableScopeIdIn - Only include variable instances which belong to one of passed scope ids. (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)
        deserializeValues - Determines whether serializable variable values (typically variables that store custom Java objects) should be deserialized on server side (default `true`). If set to `true`, a serializable variable will be deserialized on server side and transformed to JSON using [Jackson's](https://github.com/FasterXML/jackson) POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath. If set to `false`, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML. **Note:** While `true` is the default value for reasons of backward compatibility, we recommend setting this parameter to `false` when developing web applications that are independent of the Java process applications deployed to the engine. (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

      • getVariableInstancesCountCall

        public okhttp3.Call getVariableInstancesCountCall​(String variableName,
                                                  String variableNameLike,
                                                  String processInstanceIdIn,
                                                  String executionIdIn,
                                                  String caseInstanceIdIn,
                                                  String caseExecutionIdIn,
                                                  String taskIdIn,
                                                  String batchIdIn,
                                                  String activityInstanceIdIn,
                                                  String tenantIdIn,
                                                  String variableValues,
                                                  Boolean variableNamesIgnoreCase,
                                                  Boolean variableValuesIgnoreCase,
                                                  String variableScopeIdIn,
                                                  String sortBy,
                                                  String sortOrder,
                                                  ApiCallback _callback)
                                           throws ApiException
        Build call for getVariableInstancesCount
        Parameters:
        variableName - Filter by variable instance name. (optional)
        variableNameLike - Filter by the variable instance name. The parameter can include the wildcard `%` to express like-strategy such as: starts with (`%`name), ends with (name`%`) or contains (`%`name`%`). (optional)
        processInstanceIdIn - Only include variable instances which belong to one of the passed and comma-separated process instance ids. (optional)
        executionIdIn - Only include variable instances which belong to one of the passed and comma-separated execution ids. (optional)
        caseInstanceIdIn - Only include variable instances which belong to one of the passed and comma-separated case instance ids. (optional)
        caseExecutionIdIn - Only include variable instances which belong to one of the passed and comma-separated case execution ids. (optional)
        taskIdIn - Only include variable instances which belong to one of the passed and comma-separated task ids. (optional)
        batchIdIn - Only include variable instances which belong to one of the passed and comma-separated batch ids. (optional)
        activityInstanceIdIn - Only include variable instances which belong to one of the passed and comma-separated activity instance ids. (optional)
        tenantIdIn - Only include variable instances which belong to one of the passed and comma-separated tenant ids. (optional)
        variableValues - Only include variable instances that have the certain values. Value filtering expressions are comma-separated and are structured as follows: A valid parameter value has the form `key_operator_value`. `key` is the variable name, `operator` is the comparison operator to be used and `value` the variable value. **Note:** Values are always treated as `String` objects on server side. Valid operator values are: `eq` - equal to; `neq` - not equal to; `gt` - greater than; `gteq` - greater than or equal to; `lt` - lower than; `lteq` - lower than or equal to; `like`. `key` and `value` may not contain underscore or comma characters. (optional)
        variableNamesIgnoreCase - Match all variable names provided in `variableValues` case-insensitively. If set to `true` **variableName** and **variablename** are treated as equal. (optional)
        variableValuesIgnoreCase - Match all variable values provided in `variableValues` case-insensitively. If set to `true` **variableValue** and **variablevalue** are treated as equal. (optional)
        variableScopeIdIn - Only include variable instances which belong to one of passed scope ids. (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)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getVariableInstancesCount

        public CountResultDto getVariableInstancesCount​(String variableName,
                                                String variableNameLike,
                                                String processInstanceIdIn,
                                                String executionIdIn,
                                                String caseInstanceIdIn,
                                                String caseExecutionIdIn,
                                                String taskIdIn,
                                                String batchIdIn,
                                                String activityInstanceIdIn,
                                                String tenantIdIn,
                                                String variableValues,
                                                Boolean variableNamesIgnoreCase,
                                                Boolean variableValuesIgnoreCase,
                                                String variableScopeIdIn,
                                                String sortBy,
                                                String sortOrder)
                                         throws ApiException
        Get Variable Instance Count Query for the number of variable instances that fulfill given parameters. Takes the same parameters as the [Get Variable Instances](https://docs.camunda.org/manual/7.18/reference/rest/variable-instance/get-query/) method.
        Parameters:
        variableName - Filter by variable instance name. (optional)
        variableNameLike - Filter by the variable instance name. The parameter can include the wildcard `%` to express like-strategy such as: starts with (`%`name), ends with (name`%`) or contains (`%`name`%`). (optional)
        processInstanceIdIn - Only include variable instances which belong to one of the passed and comma-separated process instance ids. (optional)
        executionIdIn - Only include variable instances which belong to one of the passed and comma-separated execution ids. (optional)
        caseInstanceIdIn - Only include variable instances which belong to one of the passed and comma-separated case instance ids. (optional)
        caseExecutionIdIn - Only include variable instances which belong to one of the passed and comma-separated case execution ids. (optional)
        taskIdIn - Only include variable instances which belong to one of the passed and comma-separated task ids. (optional)
        batchIdIn - Only include variable instances which belong to one of the passed and comma-separated batch ids. (optional)
        activityInstanceIdIn - Only include variable instances which belong to one of the passed and comma-separated activity instance ids. (optional)
        tenantIdIn - Only include variable instances which belong to one of the passed and comma-separated tenant ids. (optional)
        variableValues - Only include variable instances that have the certain values. Value filtering expressions are comma-separated and are structured as follows: A valid parameter value has the form `key_operator_value`. `key` is the variable name, `operator` is the comparison operator to be used and `value` the variable value. **Note:** Values are always treated as `String` objects on server side. Valid operator values are: `eq` - equal to; `neq` - not equal to; `gt` - greater than; `gteq` - greater than or equal to; `lt` - lower than; `lteq` - lower than or equal to; `like`. `key` and `value` may not contain underscore or comma characters. (optional)
        variableNamesIgnoreCase - Match all variable names provided in `variableValues` case-insensitively. If set to `true` **variableName** and **variablename** are treated as equal. (optional)
        variableValuesIgnoreCase - Match all variable values provided in `variableValues` case-insensitively. If set to `true` **variableValue** and **variablevalue** are treated as equal. (optional)
        variableScopeIdIn - Only include variable instances which belong to one of passed scope ids. (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)
        Returns:
        CountResultDto
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getVariableInstancesCountWithHttpInfo

        public ApiResponse<CountResultDto> getVariableInstancesCountWithHttpInfo​(String variableName,
                                                                         String variableNameLike,
                                                                         String processInstanceIdIn,
                                                                         String executionIdIn,
                                                                         String caseInstanceIdIn,
                                                                         String caseExecutionIdIn,
                                                                         String taskIdIn,
                                                                         String batchIdIn,
                                                                         String activityInstanceIdIn,
                                                                         String tenantIdIn,
                                                                         String variableValues,
                                                                         Boolean variableNamesIgnoreCase,
                                                                         Boolean variableValuesIgnoreCase,
                                                                         String variableScopeIdIn,
                                                                         String sortBy,
                                                                         String sortOrder)
                                                                  throws ApiException
        Get Variable Instance Count Query for the number of variable instances that fulfill given parameters. Takes the same parameters as the [Get Variable Instances](https://docs.camunda.org/manual/7.18/reference/rest/variable-instance/get-query/) method.
        Parameters:
        variableName - Filter by variable instance name. (optional)
        variableNameLike - Filter by the variable instance name. The parameter can include the wildcard `%` to express like-strategy such as: starts with (`%`name), ends with (name`%`) or contains (`%`name`%`). (optional)
        processInstanceIdIn - Only include variable instances which belong to one of the passed and comma-separated process instance ids. (optional)
        executionIdIn - Only include variable instances which belong to one of the passed and comma-separated execution ids. (optional)
        caseInstanceIdIn - Only include variable instances which belong to one of the passed and comma-separated case instance ids. (optional)
        caseExecutionIdIn - Only include variable instances which belong to one of the passed and comma-separated case execution ids. (optional)
        taskIdIn - Only include variable instances which belong to one of the passed and comma-separated task ids. (optional)
        batchIdIn - Only include variable instances which belong to one of the passed and comma-separated batch ids. (optional)
        activityInstanceIdIn - Only include variable instances which belong to one of the passed and comma-separated activity instance ids. (optional)
        tenantIdIn - Only include variable instances which belong to one of the passed and comma-separated tenant ids. (optional)
        variableValues - Only include variable instances that have the certain values. Value filtering expressions are comma-separated and are structured as follows: A valid parameter value has the form `key_operator_value`. `key` is the variable name, `operator` is the comparison operator to be used and `value` the variable value. **Note:** Values are always treated as `String` objects on server side. Valid operator values are: `eq` - equal to; `neq` - not equal to; `gt` - greater than; `gteq` - greater than or equal to; `lt` - lower than; `lteq` - lower than or equal to; `like`. `key` and `value` may not contain underscore or comma characters. (optional)
        variableNamesIgnoreCase - Match all variable names provided in `variableValues` case-insensitively. If set to `true` **variableName** and **variablename** are treated as equal. (optional)
        variableValuesIgnoreCase - Match all variable values provided in `variableValues` case-insensitively. If set to `true` **variableValue** and **variablevalue** are treated as equal. (optional)
        variableScopeIdIn - Only include variable instances which belong to one of passed scope ids. (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)
        Returns:
        ApiResponse<CountResultDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getVariableInstancesCountAsync

        public okhttp3.Call getVariableInstancesCountAsync​(String variableName,
                                                   String variableNameLike,
                                                   String processInstanceIdIn,
                                                   String executionIdIn,
                                                   String caseInstanceIdIn,
                                                   String caseExecutionIdIn,
                                                   String taskIdIn,
                                                   String batchIdIn,
                                                   String activityInstanceIdIn,
                                                   String tenantIdIn,
                                                   String variableValues,
                                                   Boolean variableNamesIgnoreCase,
                                                   Boolean variableValuesIgnoreCase,
                                                   String variableScopeIdIn,
                                                   String sortBy,
                                                   String sortOrder,
                                                   ApiCallback<CountResultDto> _callback)
                                            throws ApiException
        Get Variable Instance Count (asynchronously) Query for the number of variable instances that fulfill given parameters. Takes the same parameters as the [Get Variable Instances](https://docs.camunda.org/manual/7.18/reference/rest/variable-instance/get-query/) method.
        Parameters:
        variableName - Filter by variable instance name. (optional)
        variableNameLike - Filter by the variable instance name. The parameter can include the wildcard `%` to express like-strategy such as: starts with (`%`name), ends with (name`%`) or contains (`%`name`%`). (optional)
        processInstanceIdIn - Only include variable instances which belong to one of the passed and comma-separated process instance ids. (optional)
        executionIdIn - Only include variable instances which belong to one of the passed and comma-separated execution ids. (optional)
        caseInstanceIdIn - Only include variable instances which belong to one of the passed and comma-separated case instance ids. (optional)
        caseExecutionIdIn - Only include variable instances which belong to one of the passed and comma-separated case execution ids. (optional)
        taskIdIn - Only include variable instances which belong to one of the passed and comma-separated task ids. (optional)
        batchIdIn - Only include variable instances which belong to one of the passed and comma-separated batch ids. (optional)
        activityInstanceIdIn - Only include variable instances which belong to one of the passed and comma-separated activity instance ids. (optional)
        tenantIdIn - Only include variable instances which belong to one of the passed and comma-separated tenant ids. (optional)
        variableValues - Only include variable instances that have the certain values. Value filtering expressions are comma-separated and are structured as follows: A valid parameter value has the form `key_operator_value`. `key` is the variable name, `operator` is the comparison operator to be used and `value` the variable value. **Note:** Values are always treated as `String` objects on server side. Valid operator values are: `eq` - equal to; `neq` - not equal to; `gt` - greater than; `gteq` - greater than or equal to; `lt` - lower than; `lteq` - lower than or equal to; `like`. `key` and `value` may not contain underscore or comma characters. (optional)
        variableNamesIgnoreCase - Match all variable names provided in `variableValues` case-insensitively. If set to `true` **variableName** and **variablename** are treated as equal. (optional)
        variableValuesIgnoreCase - Match all variable values provided in `variableValues` case-insensitively. If set to `true` **variableValue** and **variablevalue** are treated as equal. (optional)
        variableScopeIdIn - Only include variable instances which belong to one of passed scope ids. (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)
        _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

      • queryVariableInstancesCall

        public okhttp3.Call queryVariableInstancesCall​(Integer firstResult,
                                               Integer maxResults,
                                               Boolean deserializeValues,
                                               VariableInstanceQueryDto variableInstanceQueryDto,
                                               ApiCallback _callback)
                                        throws ApiException
        Build call for queryVariableInstances
        Parameters:
        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)
        deserializeValues - Determines whether serializable variable values (typically variables that store custom Java objects) should be deserialized on server side (default `true`). If set to `true`, a serializable variable will be deserialized on server side and transformed to JSON using [Jackson's](https://github.com/FasterXML/jackson) POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath. If set to `false`, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML. **Note:** While `true` is the default value for reasons of backward compatibility, we recommend setting this parameter to `false` when developing web applications that are independent of the Java process applications deployed to the engine. (optional)
        variableInstanceQueryDto - (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • queryVariableInstances

        public List<VariableInstanceDto> queryVariableInstances​(Integer firstResult,
                                                        Integer maxResults,
                                                        Boolean deserializeValues,
                                                        VariableInstanceQueryDto variableInstanceQueryDto)
                                                 throws ApiException
        Get Variable Instances (POST) Query for variable instances that fulfill given parameters through a JSON object. This method is slightly more powerful than the [Get Variable Instances](https://docs.camunda.org/manual/7.18/reference/rest/variable- instance/get-query/) method because it allows filtering by multiple variable instances of types `String`, `Number` or `Boolean`.
        Parameters:
        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)
        deserializeValues - Determines whether serializable variable values (typically variables that store custom Java objects) should be deserialized on server side (default `true`). If set to `true`, a serializable variable will be deserialized on server side and transformed to JSON using [Jackson's](https://github.com/FasterXML/jackson) POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath. If set to `false`, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML. **Note:** While `true` is the default value for reasons of backward compatibility, we recommend setting this parameter to `false` when developing web applications that are independent of the Java process applications deployed to the engine. (optional)
        variableInstanceQueryDto - (optional)
        Returns:
        List<VariableInstanceDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • queryVariableInstancesWithHttpInfo

        public ApiResponse<List<VariableInstanceDto>> queryVariableInstancesWithHttpInfo​(Integer firstResult,
                                                                                 Integer maxResults,
                                                                                 Boolean deserializeValues,
                                                                                 VariableInstanceQueryDto variableInstanceQueryDto)
                                                                          throws ApiException
        Get Variable Instances (POST) Query for variable instances that fulfill given parameters through a JSON object. This method is slightly more powerful than the [Get Variable Instances](https://docs.camunda.org/manual/7.18/reference/rest/variable- instance/get-query/) method because it allows filtering by multiple variable instances of types `String`, `Number` or `Boolean`.
        Parameters:
        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)
        deserializeValues - Determines whether serializable variable values (typically variables that store custom Java objects) should be deserialized on server side (default `true`). If set to `true`, a serializable variable will be deserialized on server side and transformed to JSON using [Jackson's](https://github.com/FasterXML/jackson) POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath. If set to `false`, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML. **Note:** While `true` is the default value for reasons of backward compatibility, we recommend setting this parameter to `false` when developing web applications that are independent of the Java process applications deployed to the engine. (optional)
        variableInstanceQueryDto - (optional)
        Returns:
        ApiResponse<List<VariableInstanceDto>>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • queryVariableInstancesAsync

        public okhttp3.Call queryVariableInstancesAsync​(Integer firstResult,
                                                Integer maxResults,
                                                Boolean deserializeValues,
                                                VariableInstanceQueryDto variableInstanceQueryDto,
                                                ApiCallback<List<VariableInstanceDto>> _callback)
                                         throws ApiException
        Get Variable Instances (POST) (asynchronously) Query for variable instances that fulfill given parameters through a JSON object. This method is slightly more powerful than the [Get Variable Instances](https://docs.camunda.org/manual/7.18/reference/rest/variable- instance/get-query/) method because it allows filtering by multiple variable instances of types `String`, `Number` or `Boolean`.
        Parameters:
        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)
        deserializeValues - Determines whether serializable variable values (typically variables that store custom Java objects) should be deserialized on server side (default `true`). If set to `true`, a serializable variable will be deserialized on server side and transformed to JSON using [Jackson's](https://github.com/FasterXML/jackson) POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath. If set to `false`, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML. **Note:** While `true` is the default value for reasons of backward compatibility, we recommend setting this parameter to `false` when developing web applications that are independent of the Java process applications deployed to the engine. (optional)
        variableInstanceQueryDto - (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

      • queryVariableInstancesCountCall

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

      • queryVariableInstancesCount

        public CountResultDto queryVariableInstancesCount​(VariableInstanceQueryDto variableInstanceQueryDto)
                                           throws ApiException
        Get Variable Instance Count (POST) Query for the number of variable instances that fulfill given parameters. This method takes the same message body as the [Get Variable Instances POST](https://docs.camunda.org/manual/7.18/reference/rest/variable- instance/post-query/) method and therefore it is slightly more powerful than the [Get Variable Instance Count](https://docs.camunda.org/manual/7.18/reference/rest/variable-instance/get-query-count/) method.
        Parameters:
        variableInstanceQueryDto - (optional)
        Returns:
        CountResultDto
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • queryVariableInstancesCountWithHttpInfo

        public ApiResponse<CountResultDto> queryVariableInstancesCountWithHttpInfo​(VariableInstanceQueryDto variableInstanceQueryDto)
                                                                    throws ApiException
        Get Variable Instance Count (POST) Query for the number of variable instances that fulfill given parameters. This method takes the same message body as the [Get Variable Instances POST](https://docs.camunda.org/manual/7.18/reference/rest/variable- instance/post-query/) method and therefore it is slightly more powerful than the [Get Variable Instance Count](https://docs.camunda.org/manual/7.18/reference/rest/variable-instance/get-query-count/) method.
        Parameters:
        variableInstanceQueryDto - (optional)
        Returns:
        ApiResponse<CountResultDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • queryVariableInstancesCountAsync

        public okhttp3.Call queryVariableInstancesCountAsync​(VariableInstanceQueryDto variableInstanceQueryDto,
                                                     ApiCallback<CountResultDto> _callback)
                                              throws ApiException
        Get Variable Instance Count (POST) (asynchronously) Query for the number of variable instances that fulfill given parameters. This method takes the same message body as the [Get Variable Instances POST](https://docs.camunda.org/manual/7.18/reference/rest/variable- instance/post-query/) method and therefore it is slightly more powerful than the [Get Variable Instance Count](https://docs.camunda.org/manual/7.18/reference/rest/variable-instance/get-query-count/) method.
        Parameters:
        variableInstanceQueryDto - (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