Справочные материалы по интерфейсу API службы REST и примеры
В MSDN можно найти документацию о REST-интерфейсе SharePoint 2013.
На этой странице представлены ссылки на часто используемые ресурсы REST, доступные разработчикам SharePoint 2013.
Дата последнего изменения: 17 ноября 2015 г.
Область применения: apps for SharePoint | SharePoint Foundation 2013 | SharePoint Server 2013
См. видео "SharePoint 2013 REST и OData: основные положения"
Совет
SharePoint Online REST поддерживает объединение нескольких запросов в одном вызове службы с помощью параметра запроса OData $batch. Дополнительные сведения и ссылки на примеры кода см. в разделе Создание пакетного запроса с помощью интерфейсов REST API. Этот параметр пока не поддерживается в локальной версии SharePoint.
Справочник по REST для SharePoint 2013
Примечание
Некоторые из следующих ссылок открывают документацию по соответствующему объекту JavaScript, при этом в нижней части страницы отображается конечная точка REST.
Базовые конечные точки REST
Ресурс |
Описание |
|---|---|
Представляет коллекцию объектов SP.Change. |
|
Представляет коллекцию объектов EventReceiverDefinition, которые используются для перечисления списка зарегистрированных приемников событий для объектов Microsoft SharePoint Foundation. |
|
Представляет коллекцию объектов SP.Feature. |
|
Представляет включенную функцию. |
|
Представляет коллекцию объектов SP.RecycleBinItem. |
|
Представляет элемент корзины сайта или семейства веб-сайтов. |
|
Представляет региональные параметры, используемые на сервере под управлением Microsoft SharePoint Foundation. |
|
Представляет семейство веб-сайтов в веб-приложении, включая веб-сайт верхнего уровня и все его дочерние сайты. |
|
Представляет сайт SharePoint. |
|
Задает коллекцию шаблонов сайта. |
|
Задает определение или шаблон сайта, используемые для создания экземпляра сайта. |
Списочные конечные точки REST
Ресурс |
Описание |
|---|---|
Представляет коллекцию ресурсов Список. |
|
Представляет список на веб-сайте SharePoint. |
|
Представляет коллекцию ресурсов ListItem. |
|
Представляет элемент или строку списка. |
|
Представляет коллекцию типов контента для веб-сайта или списка. |
|
Представляет тип контента для веб-сайта или списка. |
|
Представляет коллекцию ресурсов Поле. |
|
Представляет поле списка на веб-сайте Microsoft SharePoint Foundation. |
|
Представляет коллекцию объектов SP.FieldLink, которые являются ссылками на столбцы или поля в типе контента. |
|
Задает ссылку на поле или определение поля для типа контента. |
|
Представляет коллекцию объектов SP.Form для списка. |
|
Форма предоставляет интерфейс для отображения и редактирования отдельного элемента списка. |
|
Представляет коллекцию объектов SP.ListTemplate. |
|
Задает шаблон списка. |
|
Представляет коллекцию объектов SP.RelatedField со свойствами полей подстановки отношений. |
|
Задает отношение для поля подстановки. |
|
Представляет коллекцию ресурсов Представление. |
|
Задает представление списка. |
|
Представляет коллекцию полей в списке. |
Конечные точки REST для файлов и папок
Ресурс |
Описание |
|---|---|
Представляет коллекцию ресурсов Файл. |
|
Представляет файл на веб-сайте SharePoint, который может быть страницей веб-частей, элементом библиотеки документов или файлом в папке. |
|
Представляет коллекцию ресурсов FileVersion. |
|
Представляет версию ресурса Файл. |
|
Представляет коллекцию ресурсов Папка. |
|
Представляет папку на веб-сайте SharePoint. |
Конечные точки REST для пользователей и групп
Ресурс |
Описание |
|---|---|
Представляет коллекцию ресурсов Группа. |
|
Представляет группу на веб-сайте Microsoft SharePoint Foundation. |
|
Представляет коллекцию ресурсов RoleAssignment, которая определяет все назначения ролей для защищенного объекта. |
|
Определяет назначения ролей защищаемого объекта для пользователя или группы у веб-сайта, списка или элемента списка. |
|
Представляет коллекцию ресурсов RoleDefinition, которая определяет все назначения ролей, доступных для использования на сайте. |
|
Задает определение одной роли, включая имя, описание и набор прав. |
|
Задает определения ролей, привязанные к объекту назначения ролей. |
|
Представляет коллекцию ресурсов Пользователь. |
|
Представляет пользователя Microsoft SharePoint Foundation. |
|
Представляет коллекцию ресурсов UserCustomAction. |
|
Представляет дополнительное действие, связанное со списком, веб-сайтом или дочерним сайтом SharePoint. |
Сложные типы REST
Ресурс |
Описание |
|---|---|
Представляет лицензию приложения определенного пользователя для определенного Надстройка SharePoint. |
|
Конфигурация, связанная с субъектом приложения. |
|
Представляет ссылку на учетные данные для субъекта приложения. |
|
Представляет базовые разрешения для определения роли. |
|
Задает CAML-запрос к списку или соединенным спискам. |
|
Представляет параметр ввода метода GetListItemChangesSinceToken. |
|
Определяет запрос к журналу изменений. |
|
Представляет уникальное последовательное расположение изменения в журнале изменений. |
|
Задает свойства, используемые как параметры при инициализации нового типа контента. |
|
Представляет идентификатор типа контента. |
|
Сведения о контексте для сайта. |
|
Предоставляет сведения о библиотеке документов. |
|
Указывает сведения о создании приемника событий. |
|
Представляет объект, инкапсулирующий все параметры, которые используются для создания внешнего субъекта приложения. |
|
Представляет значение вычисляемого поля элемента списка, если значение поля содержит ошибку в вычислениях, например деление на ноль или переполнение. |
|
Представляет свойства, которые можно задать при создании поля. |
|
Представляет значения высоты над уровнем моря, широты, долготы и показателей для поля "Географическое местоположение". |
|
Задает значение подстановки для поля в элементе списка. |
|
Представляет конкретный вложенный вопрос и ответ в поле шкалы оценки элемента списка. |
|
Задает гиперссылку и описание FieldURL. |
|
Представляет значение подстановки пользовательского поля в элементе списка. |
|
Представляет свойства, которые можно настроить при создании файла с помощью метода FileCollection.Add. |
|
Объект, используемый для создания межсайтовой группы. |
|
Представляет словарь пар "ключ-значение". |
|
Представляет естественный язык, используемый в контексте Microsoft SharePoint Foundation. |
|
Представляет сведения, связанные с подключением ко внешнему источнику данных. |
|
Исключение, порождаемое, если данные в поле или элементе списка не проходят проверку. |
|
Описывает сбой проверки при вставке или обновлении элементов в списке. |
|
Задает сведения, необходимые для получения следующей страницы данных представления списка. |
|
Задает свойства нового элемента списка. |
|
Представляет поле элементов списка и его значение. |
|
Представляет узел в иерархии навигации. Иерархия навигации — это структура из узлов навигации. |
|
Представляет тип меню SiteMapProvider (SPSiteMapProvider) по умолчанию, где дамп начинается с корневого узла сайта с глубиной 10 уровней. |
|
Описывает создаваемый узел навигации. |
|
Представляет параметры, используемые для отображения данных списка в виде строки Нотация объектов JavaScript (JSON). |
|
Содержит свойства, используемые как параметры при инициализации определения роли. |
|
Представляет строку в таблице данных. |
|
Представляет таблицу данных. |
|
Предоставляет сведения о часовом поясе. |
|
Представляет сведения об обновлении семейства сайтов. |
|
Предоставляет поля, используемые для доступа к сведениям об использовании семейства веб-сайтов. |
|
Параметры для приглашения пользователя. |
|
Представляет сведения об уникальном идентификаторе поставщика удостоверений. |
|
Задает свойства, используемые для создания нового представления списка. |
|
Задает свойства нового сайта. |
|
Представляет метаданные о создании сайта. |
|
Представляет данные исходящих, необходимые для принятия веб-запроса. |
|
Содержит копию ответа сторонней службы. |
|
Представляет свойства, которые можно задать при создании поля. |
Обзоры REST для SharePoint 2013
Ресурс |
Описание |
|---|---|
Основы использования службы REST в SharePoint 2013 для чтения и изменения данных в SharePoint по веб-протоколам REST и OData. |
|
Выполнение базовых операций с использованием конечных точек SharePoint 2013 REST |
Сведения о выполнении базовых операций CRUD через REST-интерфейс SharePoint 2013. |
Добавление функции поиска в клиентские и мобильные приложения с помощью службы Search REST в SharePoint Server 2013 и любой технологии, поддерживающей веб-запросы REST. |
|
Ознакомьтесь с конечными точками REST SharePoint 2013 для ресурсов PeopleManager, ProfileLoader, UserProfile пользователя и связанных ресурсов. |
|
Подробнее о конечных точках REST SharePoint 2013 для выполнения задач, связанных с каналами. |
|
Following people and content REST API reference for SharePoint 2013 |
Подробнее о конечных точках REST SharePoint 2013 для подписки на людей и контент. |
Примеры кода REST для SharePoint 2013
Ресурс |
Описание |
|---|---|
SharePoint 2013: удаленное приложение Hello World с использованием REST |
Сведения о создании базового Надстройка SharePoint Hello World с размещением у поставщика, использующего REST-интерфейс SharePoint для чтения сведений о сайте SharePoint 2013 с удаленного веб-приложения. |
SharePoint 2013: использование службы поиска REST в приложении для SharePoint |
Сведения об отправке запроса поиска в Поиск в SharePoint 2013 через Надстройка SharePoint. |
SharePoint 2013: построение запросов REST и использование REST для просмотра сайта |
Сведения об использовании REST API SharePoint для просмотра сайта SharePoint 2013 и создания приложения, которое строит запросы для базовых операций с данными с основными объектами SharePoint, доступными в конечных точках REST. |
SharePoint 2013: выполнение основных операций доступа к данным в приложениях с помощью REST |
Сведения об использовании REST API SharePoint для выполнения базовых операций доступа к данным в списках и элементах списков SharePoint 2013. |
SharePoint 2013: выполнение основных операций с данными в файлах и папках с помощью REST |
Пример кода, использующий REST и междоменную библиотеку SharePointJavaScript для выполнения базовых операций с библиотеками документов и файлами. |
SharePoint 2013: выполнение вызовов типа политики только к приложениям в удаленном приложении (REST) |
Сведения об использовании атрибута AllowAppOnlyPolicy в REST и OAuth для обратного вызова SharePoint 2013. |
Сведения о том, как создать Надстройка SharePoint, использующее URL-адреса REST для запроса и изменения данных во внешнем списке. |
|
SharePoint 2013: использование элемента управления хрома и междоменной библиотеки (REST) |
Сведения о том, как добавить удаленную веб-страницу, где размещается элемент управления хрома и извлекаются данные из хост-сайта, с помощью междоменной библиотеки и REST в SharePoint 2013. |
SharePoint 2013: получение элементов списка с помощью междоменной библиотеки (REST) |
Сведения о том, как использовать междоменную библиотеку в Надстройки SharePoint для чтения элементов из списка, размещенного на сайте приложения. |
SharePoint 2013: запрос названия хост-сайта с помощью междоменной библиотеки (REST) |
Сведения о том, как использовать междоменную библиотеку в SharePoint 2013 для чтения свойства title хост-сайта. |
Установка настраиваемых разрешений для списка с помощью интерфейса REST |
Сведения о том, как определять точные настраиваемые разрешения для списка SharePoint с помощью интерфейса REST и JavaScript. |