@camunda8/orchestration-cluster-api
    Preparing search index...

    Type Alias SearchVariablesData

    type SearchVariablesData = {
        body?: SearchQueryRequest & {
            filter?: {
                isTruncated?: boolean;
                name?: StringFilterProperty;
                processInstanceKey?: ProcessInstanceKeyFilterProperty;
                scopeKey?:
                    | ScopeKey
                    | {
                        $eq?: ScopeKey;
                        $exists?: boolean;
                        $in?: ScopeKey[];
                        $neq?: ScopeKey;
                        $notIn?: ScopeKey[];
                    };
                tenantId?: TenantId;
                value?: StringFilterProperty;
                variableKey?: VariableKeyFilterProperty;
            };
            sort?: {
                field: | "value"
                | "name"
                | "tenantId"
                | "variableKey"
                | "scopeKey"
                | "processInstanceKey";
                order?: SortOrderEnum;
            }[];
        };
        path?: never;
        query?: { truncateValues?: boolean };
        url: "/variables/search";
    }
    Index

    Properties

    Properties

    body?: SearchQueryRequest & {
        filter?: {
            isTruncated?: boolean;
            name?: StringFilterProperty;
            processInstanceKey?: ProcessInstanceKeyFilterProperty;
            scopeKey?:
                | ScopeKey
                | {
                    $eq?: ScopeKey;
                    $exists?: boolean;
                    $in?: ScopeKey[];
                    $neq?: ScopeKey;
                    $notIn?: ScopeKey[];
                };
            tenantId?: TenantId;
            value?: StringFilterProperty;
            variableKey?: VariableKeyFilterProperty;
        };
        sort?: {
            field: | "value"
            | "name"
            | "tenantId"
            | "variableKey"
            | "scopeKey"
            | "processInstanceKey";
            order?: SortOrderEnum;
        }[];
    }

    Variable search query request.

    Type Declaration

    • Optionalfilter?: {
          isTruncated?: boolean;
          name?: StringFilterProperty;
          processInstanceKey?: ProcessInstanceKeyFilterProperty;
          scopeKey?:
              | ScopeKey
              | {
                  $eq?: ScopeKey;
                  $exists?: boolean;
                  $in?: ScopeKey[];
                  $neq?: ScopeKey;
                  $notIn?: ScopeKey[];
              };
          tenantId?: TenantId;
          value?: StringFilterProperty;
          variableKey?: VariableKeyFilterProperty;
      }

      Variable filter request.

    • Optionalsort?: {
          field:
              | "value"
              | "name"
              | "tenantId"
              | "variableKey"
              | "scopeKey"
              | "processInstanceKey";
          order?: SortOrderEnum;
      }[]

      Sort field criteria.

    path?: never
    query?: { truncateValues?: boolean }

    Type Declaration

    • OptionaltruncateValues?: boolean

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

    url: "/variables/search"