Skip to main content
Version: 8.9

Type Alias: VariableResultBase

type VariableResultBase = object;

Variable response item.

Properties​

name​

name: string;

Name of this variable.

processInstanceKey​

processInstanceKey: ProcessInstanceKey;

The key of the process instance of this variable.

rootProcessInstanceKey​

rootProcessInstanceKey: ProcessInstanceKey | null;

The key of the root process instance. The root process instance is the top-level ancestor in the process instance hierarchy. This field is only present for data belonging to process instance hierarchies created in version 8.9 or later.

scopeKey​

scopeKey: ScopeKey;

The key of the scope where this variable is directly defined. For process-level variables, this is the process instance key. For local variables, this is the key of the specific element instance (task, subprocess, gateway, event, etc.) where the variable is directly defined.

tenantId​

tenantId: TenantId;

Tenant ID of this variable.

variableKey​

variableKey: VariableKey;

The key for this variable.