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

Справочник по REST API BCS для SharePoint

  • Статья

Ссылки и библиотеки класса

Содержит справочные сведения по созданию URL-адресов rest для доступа к внешним источникам данных и управления ими с помощью служб Business Connectivity Services (BCS) в SharePoint.

Использование API RESTful для доступа к внешним данным в SharePoint

Интерфейс REST, предоставляемый SharePoint, позволяет получать доступ к большинству ресурсов SharePoint через специально созданные URL-адреса. Службы Business Connectivity Services (BCS) использует эта архитектура для предоставления доступа к внешним данным.

Так же, как и для доступа к элементам списка стандартных можно приступить к внешним данным с построения URL-адресов.

Примечание.

[!Примечание] Доступ к сущностей через BDC непосредственно не указан. Для работы с внешними данными, необходимо создать внешний список и использовать URL-адреса REST для доступа к элементам списка, содержащихся во внешнем списке.

Поддерживаемые HTTP-команды для работы с внешними списками, GET, PUT, POSTи DELETE.

В отличие от обычных списками невозможно создать внешний список, использующий REST. Необходимо выполнить, путем создания модели BDC и внешнего списка с помощью Visual Studio 2012.

Сведения, приведенные в таблице 1 показано, как для создания URL-адреса REST и соответствующие вызовы объектной модели клиента для доступа и работы с данными из внешних источников данных.

Таблица 1. Форматы URL-адресов RESTful для доступа к внешним данным

URL-адрес Описание Метод HTTP
http://[sharepointsite]/_api
Базовое все запросы REST. В виртуальном каталоге _api сопоставляется позвонить в client.svc, где используется клиентская объектная модель.
GET
http://[sharepointsite]/_api/web/title
Получает название текущего веб-сайта.
GET
http://[sharepointsite]/_api/lists
Извлечение всех списков на сайте
GET
http://[sharepointsite]/_api/lists/getbytitle('listname')
Извлекает метаданные для указанного списка.
GET
http://[sharepointsite]/_api/lists/getbytitle('listname')/items
Извлечение элементов списка в заданном списке.
GET
http://[sharepointsite]/_api/lists/getbytitle('listname')?select=Title
Извлечение названия определенный список.
GET

Создание строки запроса для фильтрации данных

Чтобы ограничить количество возвращаемых данных или сделать его более относится к пользователю, можно использовать операции фильтрации, найденные в таблице 2.

Табл. 2. Операторы для фильтрации данных

Описание Описание
eq
 Равно
Примечание. При использовании EQ для фильтрации условия фильтра передаются во внешнюю систему, в которой выполняется фильтрация на сервере.
Gt
 Больше
Примечание. При использовании оператора GT выполняется только фильтрация на стороне клиента.> Например: web/lists/getByTitle('ListName')/Items?$select=Title&$filter=AverageRating gt 3 возвращает все названия со средней оценкой более 3.

Примечание.

[!Примечание] Для получения столбцов, которые являются частью связь, необходимо явно включить столбец в URL-адрес, с помощью $select в строке запроса.

См. также