Sign in
Variable Instance

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.cibseven.org/manual/2.1/reference/rest/variable- instance/get-query/) method because it allows filtering by multiple variable instances of types String, Number or Boolean.

post/variable-instance

Request

  • Base URL: http://localhost:8080/engine-rest
  • URL: http://localhost:8080/engine-rest/variable-instance
  • Auth: HTTP basic

Query parameters

firstResultinteger

Pagination of results. Specifies the index of the first result to return.

maxResultsinteger

Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left.

deserializeValuesboolean

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 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.

Request body

variableNamestring nullable

Filter by variable instance name.

variableNameLikestring nullable

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%).

processInstanceIdInstring[] nullable

Only include variable instances which belong to one of the passed process instance ids.

executionIdInstring[] nullable

Only include variable instances which belong to one of the passed execution ids.

caseInstanceIdInstring[] nullable

Only include variable instances which belong to one of the passed case instance ids.

caseExecutionIdInstring[] nullable

Only include variable instances which belong to one of the passed case execution ids.

taskIdInstring[] nullable

Only include variable instances which belong to one of the passed task ids.

batchIdInstring[] nullable

Only include variable instances which belong to one of the passed batch ids.

activityInstanceIdInstring[] nullable

Only include variable instances which belong to one of the passed activity instance ids.

tenantIdInstring[] nullable

Only include variable instances which belong to one of the passed tenant ids.

variableNamesIgnoreCaseboolean nullable

Match all variable names provided in variableValues case-insensitively. If set to true variableName and variablename are treated as equal.

variableValuesIgnoreCaseboolean nullable

Match all variable values provided in variableValues case-insensitively. If set to true variableValue and variablevalue are treated as equal.

variableScopeIdInstring[] nullable

Only include variable instances which belong to one of passed scope ids.

Response

Request successful.

idstring nullable

The id of the variable instance.

namestring nullable

The name of the variable instance.

processDefinitionIdstring nullable

The id of the process definition that this variable instance belongs to.

processInstanceIdstring nullable

The id of the process instance that this variable instance belongs to.

executionIdstring nullable

The id of the execution that this variable instance belongs to.

caseInstanceIdstring nullable

The id of the case instance that this variable instance belongs to.

caseExecutionIdstring nullable

The id of the case execution that this variable instance belongs to.

taskIdstring nullable

The id of the task that this variable instance belongs to.

batchIdstring nullable

The id of the batch that this variable instance belongs to.<

activityInstanceIdstring nullable

The id of the activity instance that this variable instance belongs to.

tenantIdstring nullable

The id of the tenant that this variable instance belongs to.

errorMessagestring nullable

An error message in case a Java Serialized Object could not be de-serialized.

valueunknown
typestring nullable

The value type of the variable.

valueInfoobject

A JSON object containing additional, value-type-dependent properties. For serialized variables of type Object, the following properties can be provided:

  • objectTypeName: A string representation of the object's type name.
  • serializationDataFormat: The serialization format used to store the variable.

For serialized variables of type File, the following properties can be provided:

  • filename: The name of the file. This is not the variable name but the name that will be used when downloading the file again.
  • mimetype: The MIME type of the file that is being uploaded.
  • encoding: The encoding of the file that is being uploaded.

The following property can be provided for all value types:

  • transient: Indicates whether the variable should be transient or not. See documentation for more informations. (Not applicable for decision-definition, /process-instance/variables-async, and /migration/executeAsync endpoints)

Changes

No recorded changes to this operation across all 1 revision of this API.