Skip to main content
Version: 8.9 (unreleased)

Type Alias: SearchVariablesData

type SearchVariablesData = object;

Defined in: gen/types.gen.ts:17552

Properties

body?

optional body: SearchQueryRequest & object;

Defined in: gen/types.gen.ts:17556

Variable search query request.

Type Declaration

filter?
optional filter: object;

Variable filter request.

filter.isTruncated?
optional isTruncated: boolean;

Whether the value is truncated or not.

filter.name?
optional name: StringFilterProperty;

Name of the variable.

filter.processInstanceKey?
optional processInstanceKey: ProcessInstanceKeyFilterProperty;

The key of the process instance of this variable.

filter.scopeKey?
optional scopeKey: ScopeKeyFilterProperty;

The key of the scope of this variable.

filter.tenantId?
optional tenantId: TenantId;

Tenant ID of this variable.

filter.value?
optional value: StringFilterProperty;

The value of the variable.

filter.variableKey?
optional variableKey: VariableKeyFilterProperty;

The key for this variable.

sort?
optional sort: object[];

Sort field criteria.


path?

optional path: never;

Defined in: gen/types.gen.ts:17601


query?

optional query: object;

Defined in: gen/types.gen.ts:17602

truncateValues?

optional truncateValues: boolean;

When true (default), long variable values in the response are truncated. When false, full variable values are returned.


url

url: "/variables/search";

Defined in: gen/types.gen.ts:17608