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

    Type Alias SearchUserTaskEffectiveVariablesData

    type SearchUserTaskEffectiveVariablesData = {
        body?: {
            filter?: UserTaskVariableFilter;
            page?: OffsetPagination;
            sort?: {
                field:
                    | "value"
                    | "name"
                    | "tenantId"
                    | "variableKey"
                    | "scopeKey"
                    | "processInstanceKey";
                order?: SortOrderEnum;
            }[];
        };
        path: { userTaskKey: UserTaskKey };
        query?: { truncateValues?: boolean };
        url: "/user-tasks/{userTaskKey}/effective-variables/search";
    }
    Index

    Properties

    body? path query? url

    Properties

    Optionalbody

    body?: {
        filter?: UserTaskVariableFilter;
        page?: OffsetPagination;
        sort?: {
            field:
                | "value"
                | "name"
                | "tenantId"
                | "variableKey"
                | "scopeKey"
                | "processInstanceKey";
            order?: SortOrderEnum;
        }[];
    }

    User task effective variable search query request. Uses offset-based pagination only.

    Type Declaration

    • Optionalfilter?: UserTaskVariableFilter

      The user task variable search filters.

    • Optionalpage?: OffsetPagination

      Pagination parameters.

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

      Sort field criteria.

    path: { userTaskKey: UserTaskKey }

    Type Declaration

    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: "/user-tasks/{userTaskKey}/effective-variables/search"

    Settings

    Member Visibility

    On This Page

    Properties