@b-jones-rfd/sp-rest-connect - v5.1.1
    Preparing search index...

    Type Alias QueryListItemsOptions

    QueryListItemsOptions: AuthenticatedRequestOptions & {
        listName: string;
        pagingInfo?: string;
        params?: URLSearchParams;
        viewXml: string;
    }

    Options for a CAML query against a list. The request is a POST to GetItems, so it needs a request digest (managed automatically).

    Type Declaration

    • listName: string

      List display title, as shown in the SharePoint UI (not the URL segment).

    • OptionalpagingInfo?: string

      Position token for the next page, e.g. 'Paged=TRUE&p_ID=500' using the Id of the last item returned (when the view is ordered by ID). Omit for the first page.

    • Optionalparams?: URLSearchParams

      OData query options such as $select and $expand ($filter/$top belong in the CAML).

    • viewXml: string

      CAML <View> XML, e.g. <View><Query><Where><Eq><FieldRef Name='Status'/><Value Type='Text'>Open</Value></Eq></Where></Query><RowLimit>500</RowLimit></View>. Use indexed columns in <Where> to query lists above the 5,000-item view threshold.

    Settings
    Member Visibility