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

Class VariableInstanceApi

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

  • Constructor Details

    • VariableInstanceApi

      public VariableInstanceApi()

    • VariableInstanceApi

      public VariableInstanceApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • getVariableInstance

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

    • getVariableInstance

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

    • getVariableInstanceBinary

      public File getVariableInstanceBinary(String id) throws ApiException
      Get Variable Instance (Binary) Retrieves the content of a variable by id. Applicable for byte array and file variables.
      Parameters:
      id - The id of the variable instance. (required)
      Returns:
      File
      Throws:
      ApiException - if fails to make API call

    • getVariableInstanceBinary

      public File getVariableInstanceBinary(String id, Map<String,String> additionalHeaders) throws ApiException
      Get Variable Instance (Binary) Retrieves the content of a variable by id. Applicable for byte array and file variables.
      Parameters:
      id - The id of the variable instance. (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      File
      Throws:
      ApiException - if fails to make API call

    • getVariableInstances

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

    • getVariableInstances

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

    • getVariableInstancesCount

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

    • getVariableInstancesCount

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

    • queryVariableInstances

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

    • queryVariableInstances

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

    • queryVariableInstancesCount

      public CountResultDto queryVariableInstancesCount(VariableInstanceQueryDto variableInstanceQueryDto) throws ApiException
      Get Variable Instance Count (POST) Query for the number of variable instances that fulfill given parameters. This method takes the same message body as the [Get Variable Instances POST](https://docs.camunda.org/manual/7.21/reference/rest/variable- instance/post-query/) method and therefore it is slightly more powerful than the [Get Variable Instance Count](https://docs.camunda.org/manual/7.21/reference/rest/variable-instance/get-query-count/) method.
      Parameters:
      variableInstanceQueryDto - (optional)
      Returns:
      CountResultDto
      Throws:
      ApiException - if fails to make API call

    • queryVariableInstancesCount

      public CountResultDto queryVariableInstancesCount(VariableInstanceQueryDto variableInstanceQueryDto, Map<String,String> additionalHeaders) throws ApiException
      Get Variable Instance Count (POST) Query for the number of variable instances that fulfill given parameters. This method takes the same message body as the [Get Variable Instances POST](https://docs.camunda.org/manual/7.21/reference/rest/variable- instance/post-query/) method and therefore it is slightly more powerful than the [Get Variable Instance Count](https://docs.camunda.org/manual/7.21/reference/rest/variable-instance/get-query-count/) method.
      Parameters:
      variableInstanceQueryDto - (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      CountResultDto
      Throws:
      ApiException - if fails to make API call