Поделиться через

Запрашивает данные книги Excel с SharePoint Server с помощью OData

Примечание.

REST API служб Excel применим к локальным развертываниям SharePoint и SharePoint 2016. Для учетных записей Office 365 для образования, Office 365 бизнес и Office 365 корпоративный используйте REST API Excel, входящие в состав конечной точки Microsoft Graph.

URL-адреса использует OData для запроса сведений из ресурса. URL-адрес создавать определенным образом, используя параметры запроса, чтобы возвратить сведения, которые вы запрашиваете. Следующий URL-адрес показывает, как выглядит типичный запрос OData:

http://contoso1/_vti_bin/ExcelRest.aspx/Documents/ProductSales.xlsx/OData/Table1?$top=20

Таким образом, чтобы он получает первых 20 строк в таблице с именем Table1 в книге ProductSales.xlsx, которая хранится в папку «документы» на сервере contoso1 структурирован этого примера запроса OData. URL-адрес использует параметр запроса система $top чтобы указать количество возвращаемых строк.Глядя близко URL-адрес, могут видеть его структуры три части: служба корневой URI; путь к ресурсу; и параметры запроса.

URI корневого сервиса

Начальная часть URL-адреса называется корневым каталогом службы и остается неизменной для каждого запроса OData, отправляемого на сервер SharePoint, за исключением имени сервера. Она включает имя сервера SharePoint, на котором хранится книга, и путь _vti_bin / ExcelRest.aspx, как показано в следующем примере:

http://contoso1/_vti_bin/ExcelRest.aspx

Путь к ресурсу

Вторая часть URL-адреса содержит путь к книге Excel и указывает, что это запрос OData: /Documents/ProductSales.xlsx/OData

Системные параметры запросов

Третья часть URL-адреса дает система параметров запросов для запроса. Параметры запроса всегда начинаются с символа доллара ($) и добавляются в конец URI как параметры запроса. В этом примере приводится запрос для первых 20 строк в таблице с именем Table1: /Table1?$top=20.

Системные параметры запросов позволяют получить данные из ресурса. Реализация OData служб Excel поддерживает ряд параметров запроса, перечисленные в следующем разделе.

Реализация служб Excel OData поддерживает ряд стандартные параметры запроса OData система. Эти параметры запроса являются основой запросов OData с момента параметры используются для указания, какие данные требуется получить из ресурса. В следующей таблице приведены параметры запросов системы, реализация службами Excel OData в настоящее время поддерживает.

Таблица 1. Системные параметры запросов OData служб Excel

Системный параметр запроса Описание
<tableName> Возвращает все строки для таблицы, указанного идентификатором < tableName >, где < имя_таблицы > — это имя таблицы в книгу Excel, которая содержит строки, которую необходимо получить. Важно! Эта форма запроса OData возвращает не более 500 строк одновременно. Each set of 500 rows is one page. Чтобы получить строки на последующих страницах в таблице, содержащей более 500 строк, используйте параметр запроса $skiptoken (см. ниже).В следующем примере возвращаются все строки до 500-й включительно в таблице Table1 в книге ProductSales.xlsx.
$metadata Возвращает все доступные таблицы и сведения о типе для всех строк в каждой таблице в указанной книге. Следующий пример возвращает таблиц и сведения о типе для таблиц в книге ProductSales.xlsx. http://contoso1/_vti_bin/ExcelRest.aspx/Documents/ProductSales.xlsx/OData/$metadata
$orderby Возвращает строк в указанной таблице, отсортированные по значения, указанного в $orderby. Следующий пример возвращает все строки в таблице 1, отсортированные по столбце имя в книге ProductSales.xlsx. Примечание.: значение по умолчанию для $orderby возрастает. http://contoso1/_vti_bin/ExcelRest.aspx/Documents/ProductSales.xlsx/OData/Table1?$orderby=Name
$top Возвращает N строк из таблицы, где N — число указанное значение $top. Следующий пример возвращает первые 5 строк из Table1, отсортированные по имени столбца в книге ProductSales.xlsx. http://contoso1/_vti_bin/ExcelRest.aspx/Documents/ProductSales.xlsx/OData/Table1?$orderby=Имя&$top=5
$skip Пропускает N строк, N — номер, указанный по значению $skipи затем возвращает остальных строк таблицы. Следующий пример возвращает все оставшиеся строки после пятой из Table1 ProductSales.xlsx книги. http://contoso1/_vti_bin/ExcelRest.aspx/Documents/ProductSales.xlsx/OData/Table1?$skip=5
$skiptoken Операций поиска n-й строке, где N — это положение строки порядковый номер, указанный в параметре значение $skiptokenи затем возвращает всех оставшихся строк, начиная с строки N + 1. Коллекция начинается с нуля, поэтому второй строке, например, обозначается $skiptoken = 1. Следующий пример возвращает все оставшиеся строки после второй строке из Table1 ProductSales.xlsx книги. http://contoso1/_vti_bin/ExcelRest.aspx/Documents/ProductSales.xlsx/OData/Table1?$skiptoken=1 Можно также использовать параметр запроса $skiptoken для получения строк на страницах после первой страницы из таблицы, содержащей более 500 строк. Следующем примере показано, как получить строку 500th и более поздних версий, из таблицы с более чем 500 строк. http://contoso1/_vti_bin/ExcelRest.aspx/Documents/ProductSales.xlsx/OData/Table1?$skiptoken=499
$filter Возвращает набор строк, которые удовлетворяют условиям, указанным в значении $filter. Дополнительные сведения об операторах и наборе функций, которые можно использовать с $filter, см. в документации по OData. Следующий пример возвращает только строки, где значение столбца Price больше 100. Фильтр $ http://contoso1/_vti_bin/ExcelRest.aspx/Documents/ProductSales.xlsx/OData/Table1? = цена gt 100
$format Формат Atom XML поддерживается только значение и используется по умолчанию для параметра $format запрос.
$select Возвращает сущности, указанной атрибутом $select. Следующий пример выбирает в столбце имя из Table1 в книге ProductSales.xlsx. http://contoso1/_vti_bin/ExcelRest.aspx/Documents/ProductSales.xlsx/OData/Table1?$select=Name
$inlinecount Возвращает количество строк в указанной таблице. $ inlinecount можно использовать только 1 из 2 из следующих значений.
  • allpages — возвращает количество для всех строк в таблице.
  • none - не включает число строк в таблице.
В следующем примере возвращается количество для общее число строк в Table1 в книге ProductSales.xlsx. http://contoso1/_vti_bin/ExcelRest.aspx/Documents/ProductSales.xlsx/OData/Table1?$inlinecount=allpages

См. также