Interface SearchVariablesRequest

Generic search request interface that can be used for most search operations

interface SearchVariablesRequest {
    filter: VariableSearchRequestFilter;
    page?: SearchPageRequest;
    sort?: SearchSortRequest<
        | "name"
        | "value"
        | "processInstanceKey"
        | "scopeKey"
        | "tenantId"
        | "variableKey",
    >;
}

Hierarchy (View Summary)

BaseSearchRequest<
    | "value"
    | "name"
    | "tenantId"
    | "variableKey"
    | "scopeKey"
    | "processInstanceKey",
    VariableSearchRequestFilter,
>
- SearchVariablesRequest

Index

Properties

filter page? sort?

Properties

filter

filter: VariableSearchRequestFilter

Search filter criteria.

`Optional`page

page?: SearchPageRequest

Pagination criteria.

`Optional`sort

sort?: SearchSortRequest<
    | "name"
    | "value"
    | "processInstanceKey"
    | "scopeKey"
    | "tenantId"
    | "variableKey",
>

Sort field criteria.