Class HistoricVariableInstanceApi


  • public class HistoricVariableInstanceApi
    extends Object
    • Constructor Detail

      • HistoricVariableInstanceApi

        public HistoricVariableInstanceApi()
      • HistoricVariableInstanceApi

        public HistoricVariableInstanceApi​(ApiClient apiClient)
    • Method Detail

      • getApiClient

        public ApiClient getApiClient()
      • setApiClient

        public void setApiClient​(ApiClient apiClient)
      • deleteHistoricVariableInstanceCall

        public okhttp3.Call deleteHistoricVariableInstanceCall​(String id,
                                                               ApiCallback _callback)
                                                        throws ApiException
        Build call for deleteHistoricVariableInstance
        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
      • deleteHistoricVariableInstance

        public void deleteHistoricVariableInstance​(String id)
                                            throws ApiException
        Delete Variable Instance Deletes a historic variable instance by id.
        Parameters:
        id - The id of the variable instance. (required)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • deleteHistoricVariableInstanceWithHttpInfo

        public ApiResponse<Void> deleteHistoricVariableInstanceWithHttpInfo​(String id)
                                                                     throws ApiException
        Delete Variable Instance Deletes a historic variable instance by id.
        Parameters:
        id - The id of the variable instance. (required)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • deleteHistoricVariableInstanceAsync

        public okhttp3.Call deleteHistoricVariableInstanceAsync​(String id,
                                                                ApiCallback<Void> _callback)
                                                         throws ApiException
        Delete Variable Instance (asynchronously) Deletes a historic variable instance by id.
        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
      • getHistoricVariableInstanceCall

        public okhttp3.Call getHistoricVariableInstanceCall​(String id,
                                                            Boolean deserializeValues,
                                                            ApiCallback _callback)
                                                     throws ApiException
        Build call for getHistoricVariableInstance
        Parameters:
        id - The id of the variable instance. (required)
        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
      • getHistoricVariableInstance

        public HistoricVariableInstanceDto getHistoricVariableInstance​(String id,
                                                                       Boolean deserializeValues)
                                                                throws ApiException
        Get Variable Instance Retrieves a historic variable by id.
        Parameters:
        id - The id of the variable instance. (required)
        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:
        HistoricVariableInstanceDto
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • getHistoricVariableInstanceWithHttpInfo

        public ApiResponse<HistoricVariableInstanceDto> getHistoricVariableInstanceWithHttpInfo​(String id,
                                                                                                Boolean deserializeValues)
                                                                                         throws ApiException
        Get Variable Instance Retrieves a historic variable by id.
        Parameters:
        id - The id of the variable instance. (required)
        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<HistoricVariableInstanceDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • getHistoricVariableInstanceAsync

        public okhttp3.Call getHistoricVariableInstanceAsync​(String id,
                                                             Boolean deserializeValues,
                                                             ApiCallback<HistoricVariableInstanceDto> _callback)
                                                      throws ApiException
        Get Variable Instance (asynchronously) Retrieves a historic variable by id.
        Parameters:
        id - The id of the variable instance. (required)
        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
      • getHistoricVariableInstanceBinaryCall

        public okhttp3.Call getHistoricVariableInstanceBinaryCall​(String id,
                                                                  ApiCallback _callback)
                                                           throws ApiException
        Build call for getHistoricVariableInstanceBinary
        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
      • getHistoricVariableInstanceBinary

        public File getHistoricVariableInstanceBinary​(String id)
                                               throws ApiException
        Get Variable Instance (Binary) Retrieves the content of a historic variable by id. Applicable for variables that are serialized as binary data.
        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
      • getHistoricVariableInstanceBinaryWithHttpInfo

        public ApiResponse<File> getHistoricVariableInstanceBinaryWithHttpInfo​(String id)
                                                                        throws ApiException
        Get Variable Instance (Binary) Retrieves the content of a historic variable by id. Applicable for variables that are serialized as binary data.
        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
      • getHistoricVariableInstanceBinaryAsync

        public okhttp3.Call getHistoricVariableInstanceBinaryAsync​(String id,
                                                                   ApiCallback<File> _callback)
                                                            throws ApiException
        Get Variable Instance (Binary) (asynchronously) Retrieves the content of a historic variable by id. Applicable for variables that are serialized as binary data.
        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
      • getHistoricVariableInstancesCall

        public okhttp3.Call getHistoricVariableInstancesCall​(String variableName,
                                                             String variableNameLike,
                                                             Object variableValue,
                                                             Boolean variableNamesIgnoreCase,
                                                             Boolean variableValuesIgnoreCase,
                                                             String variableTypeIn,
                                                             Boolean includeDeleted,
                                                             String processInstanceId,
                                                             String processInstanceIdIn,
                                                             String processDefinitionId,
                                                             String processDefinitionKey,
                                                             String executionIdIn,
                                                             String caseInstanceId,
                                                             String caseExecutionIdIn,
                                                             String caseActivityIdIn,
                                                             String taskIdIn,
                                                             String activityInstanceIdIn,
                                                             String tenantIdIn,
                                                             Boolean withoutTenantId,
                                                             String variableNameIn,
                                                             String sortBy,
                                                             String sortOrder,
                                                             Integer firstResult,
                                                             Integer maxResults,
                                                             Boolean deserializeValues,
                                                             ApiCallback _callback)
                                                      throws ApiException
        Build call for getHistoricVariableInstances
        Parameters:
        variableName - Filter by variable name. (optional)
        variableNameLike - Restrict to variables with a name like the parameter. (optional)
        variableValue - Filter by variable value. Is treated as a `String` object on server side. (optional)
        variableNamesIgnoreCase - Match the variable name provided in `variableName` and `variableNameLike` case- insensitively. If set to `true` **variableName** and **variablename** are treated as equal. (optional)
        variableValuesIgnoreCase - Match the variable value provided in `variableValue` case-insensitively. If set to `true` **variableValue** and **variablevalue** are treated as equal. (optional)
        variableTypeIn - Only include historic variable instances which belong to one of the passed and comma- separated variable types. A list of all supported variable types can be found [here](https://docs.camunda.org/manual/7.18/user-guide/process-engine/variables/#supported-variable-values). **Note:** All non-primitive variables are associated with the type 'serializable'. (optional)
        includeDeleted - Include variables that has already been deleted during the execution. (optional)
        processInstanceId - Filter by the process instance the variable belongs to. (optional)
        processInstanceIdIn - Only include historic variable instances which belong to one of the passed and comma-separated process instance ids. (optional)
        processDefinitionId - Filter by the process definition the variable belongs to. (optional)
        processDefinitionKey - Filter by a key of the process definition the variable belongs to. (optional)
        executionIdIn - Only include historic variable instances which belong to one of the passed and and comma-separated execution ids. (optional)
        caseInstanceId - Filter by the case instance the variable belongs to. (optional)
        caseExecutionIdIn - Only include historic variable instances which belong to one of the passed and and comma-separated case execution ids. (optional)
        caseActivityIdIn - Only include historic variable instances which belong to one of the passed and and comma-separated case activity ids. (optional)
        taskIdIn - Only include historic variable instances which belong to one of the passed and and comma-separated task ids. (optional)
        activityInstanceIdIn - Only include historic variable instances which belong to one of the passed and and comma-separated activity instance ids. (optional)
        tenantIdIn - Only include historic variable instances which belong to one of the passed and comma- separated tenant ids. (optional)
        withoutTenantId - Only include historic variable instances that belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)
        variableNameIn - Only include historic variable instances which belong to one of the passed and comma-separated variable names. (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
      • getHistoricVariableInstances

        public List<HistoricVariableInstanceDto> getHistoricVariableInstances​(String variableName,
                                                                              String variableNameLike,
                                                                              Object variableValue,
                                                                              Boolean variableNamesIgnoreCase,
                                                                              Boolean variableValuesIgnoreCase,
                                                                              String variableTypeIn,
                                                                              Boolean includeDeleted,
                                                                              String processInstanceId,
                                                                              String processInstanceIdIn,
                                                                              String processDefinitionId,
                                                                              String processDefinitionKey,
                                                                              String executionIdIn,
                                                                              String caseInstanceId,
                                                                              String caseExecutionIdIn,
                                                                              String caseActivityIdIn,
                                                                              String taskIdIn,
                                                                              String activityInstanceIdIn,
                                                                              String tenantIdIn,
                                                                              Boolean withoutTenantId,
                                                                              String variableNameIn,
                                                                              String sortBy,
                                                                              String sortOrder,
                                                                              Integer firstResult,
                                                                              Integer maxResults,
                                                                              Boolean deserializeValues)
                                                                       throws ApiException
        Get Variable Instances Queries for historic variable instances that fulfill the given parameters. 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/history/variable-instance/get-variable-instance-query-count/) method.
        Parameters:
        variableName - Filter by variable name. (optional)
        variableNameLike - Restrict to variables with a name like the parameter. (optional)
        variableValue - Filter by variable value. Is treated as a `String` object on server side. (optional)
        variableNamesIgnoreCase - Match the variable name provided in `variableName` and `variableNameLike` case- insensitively. If set to `true` **variableName** and **variablename** are treated as equal. (optional)
        variableValuesIgnoreCase - Match the variable value provided in `variableValue` case-insensitively. If set to `true` **variableValue** and **variablevalue** are treated as equal. (optional)
        variableTypeIn - Only include historic variable instances which belong to one of the passed and comma- separated variable types. A list of all supported variable types can be found [here](https://docs.camunda.org/manual/7.18/user-guide/process-engine/variables/#supported-variable-values). **Note:** All non-primitive variables are associated with the type 'serializable'. (optional)
        includeDeleted - Include variables that has already been deleted during the execution. (optional)
        processInstanceId - Filter by the process instance the variable belongs to. (optional)
        processInstanceIdIn - Only include historic variable instances which belong to one of the passed and comma-separated process instance ids. (optional)
        processDefinitionId - Filter by the process definition the variable belongs to. (optional)
        processDefinitionKey - Filter by a key of the process definition the variable belongs to. (optional)
        executionIdIn - Only include historic variable instances which belong to one of the passed and and comma-separated execution ids. (optional)
        caseInstanceId - Filter by the case instance the variable belongs to. (optional)
        caseExecutionIdIn - Only include historic variable instances which belong to one of the passed and and comma-separated case execution ids. (optional)
        caseActivityIdIn - Only include historic variable instances which belong to one of the passed and and comma-separated case activity ids. (optional)
        taskIdIn - Only include historic variable instances which belong to one of the passed and and comma-separated task ids. (optional)
        activityInstanceIdIn - Only include historic variable instances which belong to one of the passed and and comma-separated activity instance ids. (optional)
        tenantIdIn - Only include historic variable instances which belong to one of the passed and comma- separated tenant ids. (optional)
        withoutTenantId - Only include historic variable instances that belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)
        variableNameIn - Only include historic variable instances which belong to one of the passed and comma-separated variable names. (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<HistoricVariableInstanceDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • getHistoricVariableInstancesWithHttpInfo

        public ApiResponse<List<HistoricVariableInstanceDto>> getHistoricVariableInstancesWithHttpInfo​(String variableName,
                                                                                                       String variableNameLike,
                                                                                                       Object variableValue,
                                                                                                       Boolean variableNamesIgnoreCase,
                                                                                                       Boolean variableValuesIgnoreCase,
                                                                                                       String variableTypeIn,
                                                                                                       Boolean includeDeleted,
                                                                                                       String processInstanceId,
                                                                                                       String processInstanceIdIn,
                                                                                                       String processDefinitionId,
                                                                                                       String processDefinitionKey,
                                                                                                       String executionIdIn,
                                                                                                       String caseInstanceId,
                                                                                                       String caseExecutionIdIn,
                                                                                                       String caseActivityIdIn,
                                                                                                       String taskIdIn,
                                                                                                       String activityInstanceIdIn,
                                                                                                       String tenantIdIn,
                                                                                                       Boolean withoutTenantId,
                                                                                                       String variableNameIn,
                                                                                                       String sortBy,
                                                                                                       String sortOrder,
                                                                                                       Integer firstResult,
                                                                                                       Integer maxResults,
                                                                                                       Boolean deserializeValues)
                                                                                                throws ApiException
        Get Variable Instances Queries for historic variable instances that fulfill the given parameters. 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/history/variable-instance/get-variable-instance-query-count/) method.
        Parameters:
        variableName - Filter by variable name. (optional)
        variableNameLike - Restrict to variables with a name like the parameter. (optional)
        variableValue - Filter by variable value. Is treated as a `String` object on server side. (optional)
        variableNamesIgnoreCase - Match the variable name provided in `variableName` and `variableNameLike` case- insensitively. If set to `true` **variableName** and **variablename** are treated as equal. (optional)
        variableValuesIgnoreCase - Match the variable value provided in `variableValue` case-insensitively. If set to `true` **variableValue** and **variablevalue** are treated as equal. (optional)
        variableTypeIn - Only include historic variable instances which belong to one of the passed and comma- separated variable types. A list of all supported variable types can be found [here](https://docs.camunda.org/manual/7.18/user-guide/process-engine/variables/#supported-variable-values). **Note:** All non-primitive variables are associated with the type 'serializable'. (optional)
        includeDeleted - Include variables that has already been deleted during the execution. (optional)
        processInstanceId - Filter by the process instance the variable belongs to. (optional)
        processInstanceIdIn - Only include historic variable instances which belong to one of the passed and comma-separated process instance ids. (optional)
        processDefinitionId - Filter by the process definition the variable belongs to. (optional)
        processDefinitionKey - Filter by a key of the process definition the variable belongs to. (optional)
        executionIdIn - Only include historic variable instances which belong to one of the passed and and comma-separated execution ids. (optional)
        caseInstanceId - Filter by the case instance the variable belongs to. (optional)
        caseExecutionIdIn - Only include historic variable instances which belong to one of the passed and and comma-separated case execution ids. (optional)
        caseActivityIdIn - Only include historic variable instances which belong to one of the passed and and comma-separated case activity ids. (optional)
        taskIdIn - Only include historic variable instances which belong to one of the passed and and comma-separated task ids. (optional)
        activityInstanceIdIn - Only include historic variable instances which belong to one of the passed and and comma-separated activity instance ids. (optional)
        tenantIdIn - Only include historic variable instances which belong to one of the passed and comma- separated tenant ids. (optional)
        withoutTenantId - Only include historic variable instances that belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)
        variableNameIn - Only include historic variable instances which belong to one of the passed and comma-separated variable names. (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<HistoricVariableInstanceDto>>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • getHistoricVariableInstancesAsync

        public okhttp3.Call getHistoricVariableInstancesAsync​(String variableName,
                                                              String variableNameLike,
                                                              Object variableValue,
                                                              Boolean variableNamesIgnoreCase,
                                                              Boolean variableValuesIgnoreCase,
                                                              String variableTypeIn,
                                                              Boolean includeDeleted,
                                                              String processInstanceId,
                                                              String processInstanceIdIn,
                                                              String processDefinitionId,
                                                              String processDefinitionKey,
                                                              String executionIdIn,
                                                              String caseInstanceId,
                                                              String caseExecutionIdIn,
                                                              String caseActivityIdIn,
                                                              String taskIdIn,
                                                              String activityInstanceIdIn,
                                                              String tenantIdIn,
                                                              Boolean withoutTenantId,
                                                              String variableNameIn,
                                                              String sortBy,
                                                              String sortOrder,
                                                              Integer firstResult,
                                                              Integer maxResults,
                                                              Boolean deserializeValues,
                                                              ApiCallback<List<HistoricVariableInstanceDto>> _callback)
                                                       throws ApiException
        Get Variable Instances (asynchronously) Queries for historic variable instances that fulfill the given parameters. 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/history/variable-instance/get-variable-instance-query-count/) method.
        Parameters:
        variableName - Filter by variable name. (optional)
        variableNameLike - Restrict to variables with a name like the parameter. (optional)
        variableValue - Filter by variable value. Is treated as a `String` object on server side. (optional)
        variableNamesIgnoreCase - Match the variable name provided in `variableName` and `variableNameLike` case- insensitively. If set to `true` **variableName** and **variablename** are treated as equal. (optional)
        variableValuesIgnoreCase - Match the variable value provided in `variableValue` case-insensitively. If set to `true` **variableValue** and **variablevalue** are treated as equal. (optional)
        variableTypeIn - Only include historic variable instances which belong to one of the passed and comma- separated variable types. A list of all supported variable types can be found [here](https://docs.camunda.org/manual/7.18/user-guide/process-engine/variables/#supported-variable-values). **Note:** All non-primitive variables are associated with the type 'serializable'. (optional)
        includeDeleted - Include variables that has already been deleted during the execution. (optional)
        processInstanceId - Filter by the process instance the variable belongs to. (optional)
        processInstanceIdIn - Only include historic variable instances which belong to one of the passed and comma-separated process instance ids. (optional)
        processDefinitionId - Filter by the process definition the variable belongs to. (optional)
        processDefinitionKey - Filter by a key of the process definition the variable belongs to. (optional)
        executionIdIn - Only include historic variable instances which belong to one of the passed and and comma-separated execution ids. (optional)
        caseInstanceId - Filter by the case instance the variable belongs to. (optional)
        caseExecutionIdIn - Only include historic variable instances which belong to one of the passed and and comma-separated case execution ids. (optional)
        caseActivityIdIn - Only include historic variable instances which belong to one of the passed and and comma-separated case activity ids. (optional)
        taskIdIn - Only include historic variable instances which belong to one of the passed and and comma-separated task ids. (optional)
        activityInstanceIdIn - Only include historic variable instances which belong to one of the passed and and comma-separated activity instance ids. (optional)
        tenantIdIn - Only include historic variable instances which belong to one of the passed and comma- separated tenant ids. (optional)
        withoutTenantId - Only include historic variable instances that belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)
        variableNameIn - Only include historic variable instances which belong to one of the passed and comma-separated variable names. (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
      • getHistoricVariableInstancesCountCall

        public okhttp3.Call getHistoricVariableInstancesCountCall​(String variableName,
                                                                  String variableNameLike,
                                                                  Object variableValue,
                                                                  Boolean variableNamesIgnoreCase,
                                                                  Boolean variableValuesIgnoreCase,
                                                                  String variableTypeIn,
                                                                  Boolean includeDeleted,
                                                                  String processInstanceId,
                                                                  String processInstanceIdIn,
                                                                  String processDefinitionId,
                                                                  String processDefinitionKey,
                                                                  String executionIdIn,
                                                                  String caseInstanceId,
                                                                  String caseExecutionIdIn,
                                                                  String caseActivityIdIn,
                                                                  String taskIdIn,
                                                                  String activityInstanceIdIn,
                                                                  String tenantIdIn,
                                                                  Boolean withoutTenantId,
                                                                  String variableNameIn,
                                                                  ApiCallback _callback)
                                                           throws ApiException
        Build call for getHistoricVariableInstancesCount
        Parameters:
        variableName - Filter by variable name. (optional)
        variableNameLike - Restrict to variables with a name like the parameter. (optional)
        variableValue - Filter by variable value. Is treated as a `String` object on server side. (optional)
        variableNamesIgnoreCase - Match the variable name provided in `variableName` and `variableNameLike` case- insensitively. If set to `true` **variableName** and **variablename** are treated as equal. (optional)
        variableValuesIgnoreCase - Match the variable value provided in `variableValue` case-insensitively. If set to `true` **variableValue** and **variablevalue** are treated as equal. (optional)
        variableTypeIn - Only include historic variable instances which belong to one of the passed and comma- separated variable types. A list of all supported variable types can be found [here](https://docs.camunda.org/manual/7.18/user-guide/process-engine/variables/#supported-variable-values). **Note:** All non-primitive variables are associated with the type 'serializable'. (optional)
        includeDeleted - Include variables that has already been deleted during the execution. (optional)
        processInstanceId - Filter by the process instance the variable belongs to. (optional)
        processInstanceIdIn - Only include historic variable instances which belong to one of the passed and comma-separated process instance ids. (optional)
        processDefinitionId - Filter by the process definition the variable belongs to. (optional)
        processDefinitionKey - Filter by a key of the process definition the variable belongs to. (optional)
        executionIdIn - Only include historic variable instances which belong to one of the passed and and comma-separated execution ids. (optional)
        caseInstanceId - Filter by the case instance the variable belongs to. (optional)
        caseExecutionIdIn - Only include historic variable instances which belong to one of the passed and and comma-separated case execution ids. (optional)
        caseActivityIdIn - Only include historic variable instances which belong to one of the passed and and comma-separated case activity ids. (optional)
        taskIdIn - Only include historic variable instances which belong to one of the passed and and comma-separated task ids. (optional)
        activityInstanceIdIn - Only include historic variable instances which belong to one of the passed and and comma-separated activity instance ids. (optional)
        tenantIdIn - Only include historic variable instances which belong to one of the passed and comma- separated tenant ids. (optional)
        withoutTenantId - Only include historic variable instances that belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)
        variableNameIn - Only include historic variable instances which belong to one of the passed and comma-separated variable names. (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
      • getHistoricVariableInstancesCount

        public CountResultDto getHistoricVariableInstancesCount​(String variableName,
                                                                String variableNameLike,
                                                                Object variableValue,
                                                                Boolean variableNamesIgnoreCase,
                                                                Boolean variableValuesIgnoreCase,
                                                                String variableTypeIn,
                                                                Boolean includeDeleted,
                                                                String processInstanceId,
                                                                String processInstanceIdIn,
                                                                String processDefinitionId,
                                                                String processDefinitionKey,
                                                                String executionIdIn,
                                                                String caseInstanceId,
                                                                String caseExecutionIdIn,
                                                                String caseActivityIdIn,
                                                                String taskIdIn,
                                                                String activityInstanceIdIn,
                                                                String tenantIdIn,
                                                                Boolean withoutTenantId,
                                                                String variableNameIn)
                                                         throws ApiException
        Get Variable Instance Count Queries for the number of historic variable instances that fulfill the given parameters. Takes the same parameters as the [Get Variable Instances](https://docs.camunda.org/manual/7.18/reference/rest/history/variable-instance/get-variable-instance-query/) method.
        Parameters:
        variableName - Filter by variable name. (optional)
        variableNameLike - Restrict to variables with a name like the parameter. (optional)
        variableValue - Filter by variable value. Is treated as a `String` object on server side. (optional)
        variableNamesIgnoreCase - Match the variable name provided in `variableName` and `variableNameLike` case- insensitively. If set to `true` **variableName** and **variablename** are treated as equal. (optional)
        variableValuesIgnoreCase - Match the variable value provided in `variableValue` case-insensitively. If set to `true` **variableValue** and **variablevalue** are treated as equal. (optional)
        variableTypeIn - Only include historic variable instances which belong to one of the passed and comma- separated variable types. A list of all supported variable types can be found [here](https://docs.camunda.org/manual/7.18/user-guide/process-engine/variables/#supported-variable-values). **Note:** All non-primitive variables are associated with the type 'serializable'. (optional)
        includeDeleted - Include variables that has already been deleted during the execution. (optional)
        processInstanceId - Filter by the process instance the variable belongs to. (optional)
        processInstanceIdIn - Only include historic variable instances which belong to one of the passed and comma-separated process instance ids. (optional)
        processDefinitionId - Filter by the process definition the variable belongs to. (optional)
        processDefinitionKey - Filter by a key of the process definition the variable belongs to. (optional)
        executionIdIn - Only include historic variable instances which belong to one of the passed and and comma-separated execution ids. (optional)
        caseInstanceId - Filter by the case instance the variable belongs to. (optional)
        caseExecutionIdIn - Only include historic variable instances which belong to one of the passed and and comma-separated case execution ids. (optional)
        caseActivityIdIn - Only include historic variable instances which belong to one of the passed and and comma-separated case activity ids. (optional)
        taskIdIn - Only include historic variable instances which belong to one of the passed and and comma-separated task ids. (optional)
        activityInstanceIdIn - Only include historic variable instances which belong to one of the passed and and comma-separated activity instance ids. (optional)
        tenantIdIn - Only include historic variable instances which belong to one of the passed and comma- separated tenant ids. (optional)
        withoutTenantId - Only include historic variable instances that belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)
        variableNameIn - Only include historic variable instances which belong to one of the passed and comma-separated variable names. (optional)
        Returns:
        CountResultDto
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • getHistoricVariableInstancesCountWithHttpInfo

        public ApiResponse<CountResultDto> getHistoricVariableInstancesCountWithHttpInfo​(String variableName,
                                                                                         String variableNameLike,
                                                                                         Object variableValue,
                                                                                         Boolean variableNamesIgnoreCase,
                                                                                         Boolean variableValuesIgnoreCase,
                                                                                         String variableTypeIn,
                                                                                         Boolean includeDeleted,
                                                                                         String processInstanceId,
                                                                                         String processInstanceIdIn,
                                                                                         String processDefinitionId,
                                                                                         String processDefinitionKey,
                                                                                         String executionIdIn,
                                                                                         String caseInstanceId,
                                                                                         String caseExecutionIdIn,
                                                                                         String caseActivityIdIn,
                                                                                         String taskIdIn,
                                                                                         String activityInstanceIdIn,
                                                                                         String tenantIdIn,
                                                                                         Boolean withoutTenantId,
                                                                                         String variableNameIn)
                                                                                  throws ApiException
        Get Variable Instance Count Queries for the number of historic variable instances that fulfill the given parameters. Takes the same parameters as the [Get Variable Instances](https://docs.camunda.org/manual/7.18/reference/rest/history/variable-instance/get-variable-instance-query/) method.
        Parameters:
        variableName - Filter by variable name. (optional)
        variableNameLike - Restrict to variables with a name like the parameter. (optional)
        variableValue - Filter by variable value. Is treated as a `String` object on server side. (optional)
        variableNamesIgnoreCase - Match the variable name provided in `variableName` and `variableNameLike` case- insensitively. If set to `true` **variableName** and **variablename** are treated as equal. (optional)
        variableValuesIgnoreCase - Match the variable value provided in `variableValue` case-insensitively. If set to `true` **variableValue** and **variablevalue** are treated as equal. (optional)
        variableTypeIn - Only include historic variable instances which belong to one of the passed and comma- separated variable types. A list of all supported variable types can be found [here](https://docs.camunda.org/manual/7.18/user-guide/process-engine/variables/#supported-variable-values). **Note:** All non-primitive variables are associated with the type 'serializable'. (optional)
        includeDeleted - Include variables that has already been deleted during the execution. (optional)
        processInstanceId - Filter by the process instance the variable belongs to. (optional)
        processInstanceIdIn - Only include historic variable instances which belong to one of the passed and comma-separated process instance ids. (optional)
        processDefinitionId - Filter by the process definition the variable belongs to. (optional)
        processDefinitionKey - Filter by a key of the process definition the variable belongs to. (optional)
        executionIdIn - Only include historic variable instances which belong to one of the passed and and comma-separated execution ids. (optional)
        caseInstanceId - Filter by the case instance the variable belongs to. (optional)
        caseExecutionIdIn - Only include historic variable instances which belong to one of the passed and and comma-separated case execution ids. (optional)
        caseActivityIdIn - Only include historic variable instances which belong to one of the passed and and comma-separated case activity ids. (optional)
        taskIdIn - Only include historic variable instances which belong to one of the passed and and comma-separated task ids. (optional)
        activityInstanceIdIn - Only include historic variable instances which belong to one of the passed and and comma-separated activity instance ids. (optional)
        tenantIdIn - Only include historic variable instances which belong to one of the passed and comma- separated tenant ids. (optional)
        withoutTenantId - Only include historic variable instances that belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)
        variableNameIn - Only include historic variable instances which belong to one of the passed and comma-separated variable names. (optional)
        Returns:
        ApiResponse<CountResultDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • getHistoricVariableInstancesCountAsync

        public okhttp3.Call getHistoricVariableInstancesCountAsync​(String variableName,
                                                                   String variableNameLike,
                                                                   Object variableValue,
                                                                   Boolean variableNamesIgnoreCase,
                                                                   Boolean variableValuesIgnoreCase,
                                                                   String variableTypeIn,
                                                                   Boolean includeDeleted,
                                                                   String processInstanceId,
                                                                   String processInstanceIdIn,
                                                                   String processDefinitionId,
                                                                   String processDefinitionKey,
                                                                   String executionIdIn,
                                                                   String caseInstanceId,
                                                                   String caseExecutionIdIn,
                                                                   String caseActivityIdIn,
                                                                   String taskIdIn,
                                                                   String activityInstanceIdIn,
                                                                   String tenantIdIn,
                                                                   Boolean withoutTenantId,
                                                                   String variableNameIn,
                                                                   ApiCallback<CountResultDto> _callback)
                                                            throws ApiException
        Get Variable Instance Count (asynchronously) Queries for the number of historic variable instances that fulfill the given parameters. Takes the same parameters as the [Get Variable Instances](https://docs.camunda.org/manual/7.18/reference/rest/history/variable-instance/get-variable-instance-query/) method.
        Parameters:
        variableName - Filter by variable name. (optional)
        variableNameLike - Restrict to variables with a name like the parameter. (optional)
        variableValue - Filter by variable value. Is treated as a `String` object on server side. (optional)
        variableNamesIgnoreCase - Match the variable name provided in `variableName` and `variableNameLike` case- insensitively. If set to `true` **variableName** and **variablename** are treated as equal. (optional)
        variableValuesIgnoreCase - Match the variable value provided in `variableValue` case-insensitively. If set to `true` **variableValue** and **variablevalue** are treated as equal. (optional)
        variableTypeIn - Only include historic variable instances which belong to one of the passed and comma- separated variable types. A list of all supported variable types can be found [here](https://docs.camunda.org/manual/7.18/user-guide/process-engine/variables/#supported-variable-values). **Note:** All non-primitive variables are associated with the type 'serializable'. (optional)
        includeDeleted - Include variables that has already been deleted during the execution. (optional)
        processInstanceId - Filter by the process instance the variable belongs to. (optional)
        processInstanceIdIn - Only include historic variable instances which belong to one of the passed and comma-separated process instance ids. (optional)
        processDefinitionId - Filter by the process definition the variable belongs to. (optional)
        processDefinitionKey - Filter by a key of the process definition the variable belongs to. (optional)
        executionIdIn - Only include historic variable instances which belong to one of the passed and and comma-separated execution ids. (optional)
        caseInstanceId - Filter by the case instance the variable belongs to. (optional)
        caseExecutionIdIn - Only include historic variable instances which belong to one of the passed and and comma-separated case execution ids. (optional)
        caseActivityIdIn - Only include historic variable instances which belong to one of the passed and and comma-separated case activity ids. (optional)
        taskIdIn - Only include historic variable instances which belong to one of the passed and and comma-separated task ids. (optional)
        activityInstanceIdIn - Only include historic variable instances which belong to one of the passed and and comma-separated activity instance ids. (optional)
        tenantIdIn - Only include historic variable instances which belong to one of the passed and comma- separated tenant ids. (optional)
        withoutTenantId - Only include historic variable instances that belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)
        variableNameIn - Only include historic variable instances which belong to one of the passed and comma-separated variable names. (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
      • queryHistoricVariableInstancesCall

        public okhttp3.Call queryHistoricVariableInstancesCall​(Integer firstResult,
                                                               Integer maxResults,
                                                               Boolean deserializeValues,
                                                               HistoricVariableInstanceQueryDto historicVariableInstanceQueryDto,
                                                               ApiCallback _callback)
                                                        throws ApiException
        Build call for queryHistoricVariableInstances
        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)
        historicVariableInstanceQueryDto - (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
      • queryHistoricVariableInstances

        public List<HistoricVariableInstanceDto> queryHistoricVariableInstances​(Integer firstResult,
                                                                                Integer maxResults,
                                                                                Boolean deserializeValues,
                                                                                HistoricVariableInstanceQueryDto historicVariableInstanceQueryDto)
                                                                         throws ApiException
        Get Variable Instances (POST) Queries for historic variable instances that fulfill the given parameters. This method is slightly more powerful than the [Get Variable Instances](https://docs.camunda.org/manual/7.18/reference/rest/history/variable-instance/get-variable-instance-query/) method because it allows filtering by variable values of the different 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)
        historicVariableInstanceQueryDto - (optional)
        Returns:
        List<HistoricVariableInstanceDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • queryHistoricVariableInstancesWithHttpInfo

        public ApiResponse<List<HistoricVariableInstanceDto>> queryHistoricVariableInstancesWithHttpInfo​(Integer firstResult,
                                                                                                         Integer maxResults,
                                                                                                         Boolean deserializeValues,
                                                                                                         HistoricVariableInstanceQueryDto historicVariableInstanceQueryDto)
                                                                                                  throws ApiException
        Get Variable Instances (POST) Queries for historic variable instances that fulfill the given parameters. This method is slightly more powerful than the [Get Variable Instances](https://docs.camunda.org/manual/7.18/reference/rest/history/variable-instance/get-variable-instance-query/) method because it allows filtering by variable values of the different 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)
        historicVariableInstanceQueryDto - (optional)
        Returns:
        ApiResponse<List<HistoricVariableInstanceDto>>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • queryHistoricVariableInstancesAsync

        public okhttp3.Call queryHistoricVariableInstancesAsync​(Integer firstResult,
                                                                Integer maxResults,
                                                                Boolean deserializeValues,
                                                                HistoricVariableInstanceQueryDto historicVariableInstanceQueryDto,
                                                                ApiCallback<List<HistoricVariableInstanceDto>> _callback)
                                                         throws ApiException
        Get Variable Instances (POST) (asynchronously) Queries for historic variable instances that fulfill the given parameters. This method is slightly more powerful than the [Get Variable Instances](https://docs.camunda.org/manual/7.18/reference/rest/history/variable-instance/get-variable-instance-query/) method because it allows filtering by variable values of the different 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)
        historicVariableInstanceQueryDto - (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
      • queryHistoricVariableInstancesCountCall

        public okhttp3.Call queryHistoricVariableInstancesCountCall​(HistoricVariableInstanceQueryDto historicVariableInstanceQueryDto,
                                                                    ApiCallback _callback)
                                                             throws ApiException
        Build call for queryHistoricVariableInstancesCount
        Parameters:
        historicVariableInstanceQueryDto - (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
      • queryHistoricVariableInstancesCount

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

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

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