次の方法で共有

retrieveMultipleRecords

テーブル レコードのコレクションを取得します。

使用可能な対象

モデル駆動型アプリ & ポータル

構文

context.webAPI.retrieveMultipleRecords(entityLogicalName, options, maxPageSize).then(successCallback, errorCallback);

Parameters

名前 タイプ 必須 説明
entityLogicalName String はい 取得するレコードのテーブルの論理名。 たとえば、「account」。
options String いいえ

データを取得する OData システム クエリ オプションまたは FetchXML クエリ。

  • システム クエリ オプション $select、$top、$filter、$expand、および $orderby はサポートされます。
  • FetchXML クエリを指定するには、クエリを指定する fetchXml 列を使用します。

メモ: $select システム クエリ オプションを使用し、プロパティ名のコンマ区切りリストを含めて、テーブル レコードに対して返されるプロパティを制限する必要があります。 取得する列を制限することは、パフォーマンスに関する重要なベスト プラクティスです。 プロパティが $select を使用して指定されていない場合は、すべてのプロパティが返されます。

? で始まるクエリ オプションを指定します。 クエリ オプションを & で区切って、複数のシステム クエリ オプションを指定することもできます。

maxPageSize 数 いいえ

ページごとに返されるテーブル レコードの数を表す正の数を指定します。 このパラメーターを指定しない場合、既定の 5000 が渡されます。

取得されるレコード数が、指定された maxPageSize 値より多い場合は、返された Promise オブジェクト内の nextLink 属性に、テーブルの次のセットを取得するためのリンクが含まれます。

successCallback Function いいえ

テーブル レコードを取得した場合に呼び出す関数。 次の列のオブジェクトは関数に渡されます。

  • entities: JSON オブジェクトの配列。各オブジェクトは、列と値のペア key: value を含む、取得したテーブル レコードを表します。 既定では、テーブル レコードの ID が取得されます。
  • nextLink: 文字列。 取得されるレコードの件数が、要求内の maxPageSize パラメーターで指定された値より多い場合、この列はレコードの次のセットを返す URL を返します。
errorCallback Function いいえ 処理が失敗したときに呼び出す関数。

戻り値

種類: Promise<RetrieveMultipleResponse>

説明: RetrieveMultipleResponse は、要求内でページング () が指定され、返されるレコード数がページング値を超える場合にレコードの次のセットを指す URL とともに、取得したテーブル レコードおよび maxPageSize パラメーターを含む JSON オブジェクトの配列を含む promise を返します。 これには次のパラメータが使用されています :

パラメータ 戻り値 説明
entities Entity[] 各オブジェクトが列とその値を含む取得されたテーブル レコードを表す、JSON オブジェクトの配列。
nextLink string 取得されるレコードの件数が、要求内の 'maxPageSize' パラメーターで指定された値より多い場合、このパラメーターはレコードの次のセットを返す URL を返します。

Web API
Power Apps Component Framework API リファレンス
Power Apps Component Framework の概要

  • Last updated on