Skip to main content
Version: 8.9

Type Alias: VariableFilter

type VariableFilter = object;

Variable filter request.

Properties​

isTruncated?​

optional isTruncated?: boolean;

Whether the value is truncated or not.

name?​

optional name?: StringFilterProperty;

Name of the variable.

processInstanceKey?​

optional processInstanceKey?: ProcessInstanceKeyFilterProperty;

The key of the process instance of this variable.

scopeKey?​

optional scopeKey?: ScopeKeyFilterProperty;

The key of the scope that defines where this variable is directly defined. This can be a process instance key (for process-level variables) or an element instance key (for local variables scoped to tasks, subprocesses, gateways, events, etc.). Use this filter to find variables directly defined in specific scopes. Note that this does not include variables from parent scopes that would be visible through the scope hierarchy.

tenantId?​

optional tenantId?: TenantId;

Tenant ID of this variable.

value?​

optional value?: StringFilterProperty;

The value of the variable. Variable values in filters need to be in serialized JSON format. For example, a variable with string value myValue can be found with the filter value "myValue". Consider appropriate escaping for special characters in JSON strings when constructing filter values.

variableKey?​

optional variableKey?: VariableKeyFilterProperty;

The key for this variable.