retrieveMultipleRecords

Извлекает коллекцию записей таблиц.

Доступно для

Приложения на основе модели и порталы.

Синтаксис

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

Параметры

Имя	Тип	Обязательно	Description
entityLogicalName	String	Да	Логическое имя таблицы записей, которые требуется извлечь. Например: «счет».
options	String	нет	Параметры системного запроса OData или запрос FetchXML для получения данных. Поддерживаются следующие параметры системного запроса: $select, $top, $filter, $expand и $orderby. Чтобы указать запрос FetchXML, используйте fetchXml столбец для указания запроса. ПРИМЕЧАНИЕ. Для ограничения свойств, возвращаемых для записи таблицы, всегда следует использовать параметр $select системного запроса, включая список имен свойств, разделенных запятыми. Ограничение полученных столбцов является важной рекомендацией по повышению производительности. Если свойства не указаны с помощью $select, будут возвращены все свойства. Параметры запроса указываются, начиная с ?. Можно также указать несколько параметров системного запроса, используя & для разделения параметров запроса.
maxPageSize	Number	нет	Укажите положительное число, указывающее количество возвращаемых записей таблицы на страницу. Если этот параметр не указан, значение по умолчанию передается как 5000. Если число извлекаемых записей превышает указанное maxPageSize значение, nextLink столбец в возвращаемом объекте обещания будет содержать ссылку для получения следующего набора таблиц.
successОбратный звонок	Функция	нет	Функция для вызова при извлечении записей таблиц. Объект со следующими столбцами передается функции: сущности: массив объектов JSON, где каждый объект представляет полученную запись таблицы, содержащую столбцы и их значения в виде key: value пар. Идентификатор записи таблицы извлекается по умолчанию. nextLink: String. Если количество извлекаемых записей превышает значение, указанное в maxPageSize параметре в запросе, этот столбец возвращает URL-адрес для возврата следующего набора записей.
errorCallback	Функция	нет	Функция, вызываемая при сбое операции.

Возвращаемое значение

Тип: Promise<RetrieveMultipleResponse>

Описание. Возвращает RetrieveMultipleResponse обещание, содержащее массив объектов JSON, содержащих извлеченные записи таблицы и параметр nextLink с URL-адресом, указывающим на следующий набор записей в случае разбиения на страницы (maxPageSize) в запросе, а счетчик записей, возвращенный выше значения разбиения по страницам. Он имеет следующие параметры:

параметр	Возвращаемое значение	Description
entities	Entity[]	Массив объектов JSON, где каждый объект представляет полученную запись таблицы, содержащую столбцы и их значения.
nextLink	string	Если количество извлекаемых записей превышает значение, указанное в параметре maxPageSize в запросе, этот параметр возвращает URL-адрес для возврата следующего набора записей.

Связанные статьи

Веб-API
Справочник по API платформы компонентов Power Apps
Обзор платформы компонентов Power Apps