通过

retrieveMultipleRecords

检索表记录的集合。

适用于

模型驱动应用和门户。

Syntax

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

参数

Name 类型 必选 Description
实体逻辑名称 String 是的 要检索的记录的表逻辑名称。 例如：“帐户”。
options String 否

OData 系统查询选项或 FetchXML 查询以检索数据。

  • 支持以下系统查询选项： $select、 $top、 $filter、 $expand和 $orderby。
  • 若要指定 FetchXML 查询，请使用 fetchXml 列指定查询。

注意：必须始终使用 $select 系统查询选项来限制表记录返回的属性，方法是包括以逗号分隔的属性名称列表。 限制检索的列是一个重要的性能最佳做法。 如果未使用 $select指定属性，将返回所有属性。

您指定以 ?. 还可以通过使用 & 分隔查询选项来指定多个系统查询选项。

maxPageSize 编号 否

指定一个正数，指示每页要返回的表记录数。 如果未指定此参数，则默认值将传递为 5,000。

如果检索的记录数大于指定的 maxPageSize 值， nextLink 则返回的 promise 对象中的列将包含用于检索下一组表的链接。

successCallback 回调 功能 否

检索表记录时要调用的函数。 将包含以下列的对象传递给函数：

  • 实体：JSON 对象的数组，其中每个对象表示包含列及其值作为 key: value 对的检索表记录。 默认情况下检索表记录的 ID。
  • nextLink：字符串。 如果检索的记录数大于请求中参数中指定的 maxPageSize 值，则此列返回 URL 以返回下一组记录。
errorCallback 回调 功能 否 作失败时要调用的函数。

返回值

类型： Promise<RetrieveMultipleResponse>

说明：返回 RetrieveMultipleResponse 一个承诺，其中包含包含检索的表记录的 JSON 对象数组，以及指向下一组记录的 URL 的 NEXTLink 参数，以防请求中指定分页（maxPageSize），返回的记录计数超过分页值。 它具有以下参数：

参数 返回值 Description
entities Entity[] JSON 对象的数组，其中每个对象表示包含列及其值的检索表记录。
nextLink string 如果检索的记录数大于请求中“maxPageSize”参数中指定的值，则此参数返回 URL 以返回下一组记录。

Web API
Power Apps 组件框架 API 参考
Power Apps 组件框架概述