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

Class HistoricVariableInstanceApi

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

  • Constructor Details

    • HistoricVariableInstanceApi

      public HistoricVariableInstanceApi()

    • HistoricVariableInstanceApi

      public HistoricVariableInstanceApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

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

    • deleteHistoricVariableInstance

      public void deleteHistoricVariableInstance(String id, Map<String,String> additionalHeaders) throws ApiException
      Delete Variable Instance Deletes a historic variable instance by id.
      Parameters:
      id - The id of the variable instance. (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

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

    • getHistoricVariableInstance

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

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

    • getHistoricVariableInstanceBinary

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

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

    • 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, Map<String,String> additionalHeaders) 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.21/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.21/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)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<HistoricVariableInstanceDto>
      Throws:
      ApiException - if fails to make API call

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

    • 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, Map<String,String> additionalHeaders) 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.21/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.21/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)
      additionalHeaders - additionalHeaders for this call
      Returns:
      CountResultDto
      Throws:
      ApiException - if fails to make API call

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

    • queryHistoricVariableInstances

      public List<HistoricVariableInstanceDto> queryHistoricVariableInstances(Integer firstResult, Integer maxResults, Boolean deserializeValues, HistoricVariableInstanceQueryDto historicVariableInstanceQueryDto, Map<String,String> additionalHeaders) 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.21/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)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<HistoricVariableInstanceDto>
      Throws:
      ApiException - if fails to make API call

    • 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.21/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.21/reference/rest/history/variable-instance/get-variable-instance-query-count/) method.
      Parameters:
      historicVariableInstanceQueryDto - (optional)
      Returns:
      CountResultDto
      Throws:
      ApiException - if fails to make API call

    • queryHistoricVariableInstancesCount

      public CountResultDto queryHistoricVariableInstancesCount(HistoricVariableInstanceQueryDto historicVariableInstanceQueryDto, Map<String,String> additionalHeaders) 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.21/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.21/reference/rest/history/variable-instance/get-variable-instance-query-count/) method.
      Parameters:
      historicVariableInstanceQueryDto - (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      CountResultDto
      Throws:
      ApiException - if fails to make API call