擷取資料表記錄的集合。
適用於
模型導向應用程式和入口網站。
語法
context.webAPI.retrieveMultipleRecords(entityLogicalName, options, maxPageSize).then(successCallback, errorCallback);
參數
| 名稱 | 類型 | 為必填項目 | Description |
|---|---|---|---|
| 實體邏輯名稱 | 繩子 | Yes | 您要擷取之記錄的資料表邏輯名稱。 例如:「帳戶」。 |
| options | 繩子 | 否 | OData 系統查詢選項或 FetchXML 查詢來擷取您的資料。
附註: 您必須一律使用 $select 系統查詢選項,以包含逗號分隔的屬性名稱清單來限制表格記錄傳回的屬性。 限制您擷取的資料行是重要的效能最佳實務。 如果未使用 $select 指定屬性,則會傳回所有屬性。 您指定以 |
| 最大頁面大小 | Number | 否 | 指定正數,指出每頁要傳回的表格記錄數。 如果您未指定此參數,則預設值會傳遞為 5,000。 如果檢索的記錄數大於指定的 |
| successCallback 回調 | 功能 | 否 | 擷取資料表記錄時要呼叫的函式。 具有下列資料行的物件會傳遞至函式:
|
| errorCallback 回調 | 功能 | 否 | 作業失敗時要呼叫的函式。 |
傳回值
類型: Promise<RetrieveMultipleResponse>
說明:傳 RetrieveMultipleResponse 回一個承諾,其中包含包含擷取的資料表記錄和 nextLink 參數的 JSON 物件陣列,如果在請求中指定分頁 (maxPageSize) 且傳回的記錄計數超過分頁值,則 URL 指向下一組記錄。 它具有以下參數:
| 參數 | 傳回值 | Description |
|---|---|---|
| entities | Entity[] |
JSON 物件陣列,其中每個物件代表擷取的資料表記錄,其中包含資料行及其值。 |
| nextLink | string |
如果擷取的記錄數目大於要求中 'maxPageSize' 參數中指定的值,則此參數會傳回 URL 以傳回下一組記錄。 |