Справочные материалы по интерфейсу API службы REST для веб-сайтов

Ознакомьтесь с ресурсами и конечными точками API REST SharePoint, связанными с сайтами.

Дата последнего изменения: 15 сентября 2016 г.

Область применения: apps for SharePoint | SharePoint Online | SharePoint Server 2013

О примерах запросов в этой статье

В примерах в этой статье используются запросы jQuery AJAX. Выполните следующие действия, прежде чем пытаться использовать примеры:

  • Замените <URL-адрес сайта> и другие заполнители, такие как идентификаторы, имена или пути объектов SharePoint.

  • Если вы используете междоменную библиотеку, необходимо изменить формат запроса. Например, он может выглядеть следующим образом.

    executor.executeAsync({
      url: "<app web url>/_api/SP.AppContextSite(@target)/web/getchanges?@target='<host web url>'",
      method: "POST",
      body: "{ 'query': { '__metadata': { 'type': 'SP.ChangeQuery' }, 'Web': true, 'Update': true } }",
      headers: {
        "accept": "application/json;odata=verbose",
        "content-type": "application/json;odata=verbose"
      },
      success: successHandler,
      error: errorHandler
    });
    
  • Если вы используете OAuth, добавьте заголовок Authorization ("Authorization": "Bearer " + <access token>), чтобы отправить маркер доступа OAuth.

  • Удалите разрывы строки из значений свойств url и data в примерах запросов. Они добавлены в примеры, чтобы облегчить чтение.

  • Если вы хотите, чтобы сервер возвращал ответы в формате Atom, удалите заголовок "accept": "application/json;odata=verbose".

Дополнительные сведения об изменении запросов см. в разделе Отличия запросов REST в разных средах. В разделе Дополнительные ресурсы представлены ссылки на дополнительные сведения об использовании междоменной библиотеки, протокола OAuth и службы SharePoint REST.

Совет

SharePoint Online REST поддерживает объединение нескольких запросов в одном вызове службы с помощью параметра запроса OData $batch. Дополнительные сведения и ссылки на примеры кода см. в разделе Создание пакетного запроса с помощью интерфейсов REST API. Этот параметр пока не поддерживается в локальной версии SharePoint.

Ресурс Web

URI конечной точки  |  Свойства  |  Методы  |  Представление OData

Представляет сайт SharePoint. Тип сайта — SP.SecurableObject.

URI конечной точки

http://<URL-адрес сайта>/_api/web

Поддерживаемые методы HTTP-запросов

GET  |  POST  |  DELETE  |  MERGE  |  PUT

Примеры запросов

Пример запроса GET: получение сайта

$.ajax({
  url: "http://<site url>/_api/web",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Пример запроса POST: создание сайта с помощью метода Add ресурса WebCollection

$.ajax({
  url: "http://<site url>/_api/web/webs/add",
  type: "POST",
  data: "{ 'parameters': { '__metadata': { 'type': 'SP.WebCreationInformation' },
    'Title': 'Team projects', 'Url': 'TeamProjects', 'WebTemplate': 'STS',
    'UseSamePermissionsAsParentSite': true } }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "accept": "application/json;odata=verbose",
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>
  },
  success: successHandler,
  error: errorHandler
});

Или же можно воспользоваться методом Add ресурса WebInformationCollection, как показано в разделе Создание сайта с помощью REST.

Пример запроса MERGE: изменение сайта

$.ajax({
  url: "http://<site url>/_api/web",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.Web' }, 'Description': 'All team projects',
    'EnableMinimalDownload': false }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "accept": "application/json;odata=verbose",
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>,
    "X-HTTP-Method": "MERGE"
  },
  success: successHandler,
  error: errorHandler
});

Пример запроса DELETE: удаление сайта

$.ajax({
  url: "http://<site url>/_api/web",
  type: "POST",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "X-HTTP-Method": "DELETE"
  },
  success: successHandler,
  error: errorHandler
});

Свойства Web

Чтобы получить свойство, отправьте запрос GET в конечную точку свойства, как показано в следующем примере.

$.ajax({
  url: "http://<site url>/_api/web/<property name>",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Свойство

Тип

R/W

Возвращено с ресурсом

Описание

AllowCreateDeclarativeWorkflowForCurrentUser

Boolean

R

Нет

Указывает, может ли текущий пользователь создавать декларативные рабочие процессы. Если это свойство не отключено в веб-приложении, значение совпадает со значением свойства AllowCreateDeclarativeWorkflow семейства веб-сайтов. Значение по умолчанию: true.

AllowDesignerForCurrentUser

Boolean

R

Нет

Получает значение, указывающее, может ли текущий пользователь использовать приложение-конструктор для настройки этого сайта.

AllowMasterPageEditingForCurrentUser

Boolean

R

Нет

Получает значение, указывающее, может ли текущий пользователь изменить главную страницу.

AllowRevertFromTemplateForCurrentUser

Boolean

R

Нет

Получает значение, указывающее, может ли текущий пользователь вернуть сайт к шаблону по умолчанию.

AllowRssFeeds

Boolean

R

Да

Получает значение, указывающее, допускает ли сайт использование RSS-каналов.

AllowSaveDeclarativeWorkflowAsTemplateForCurrentUser

Boolean

R

Нет

Указывает, может ли текущий пользователь сохранять декларативные рабочие процессы как шаблон. Если это свойство не отключено в веб-приложении, значение совпадает со значением свойства AllowSaveDeclarativeWorkflowAsTemplate семейства веб-сайтов. Значение по умолчанию: true.

AllowSavePublishDeclarativeWorkflowForCurrentUser

Boolean

RW

Нет

Указывает, может ли текущий пользователь сохранять или публиковать декларативные рабочие процессы. Если это свойство не отключено в веб-приложении, значение совпадает со значением свойства AllowSavePublishDeclarativeWorkflowAsTemplate семейства веб-сайтов. Если свойство включено, значение может задать только администратор семейства веб-сайтов. Значение по умолчанию: true.

AllProperties

SP.PropertyValues

R

Нет

Получает коллекцию метаданных для веб-сайта.

AppInstanceId

GUID

R

Да

Идентификатор экземпляра приложения, представленного данным веб-сайтом.

AssociatedMemberGroup

SP.Group

RW

Нет

Получает или задает группу пользователей, которым предоставлены авторские разрешения для веб-сайта.

AssociatedOwnerGroup

SP.Group

RW

Нет

Получает или задает связанную группу владельцев веб-сайта.

AssociatedVisitorGroup

SP.Group

RW

Нет

Получает или задает связанную группу посетителей веб-сайта.

AvailableContentTypes

SP.ContentTypeCollection

R

Нет

Получает коллекцию всех типов контента, применяемых в текущей области, включая типы текущего и всех родительских веб-сайтов.

AvailableFields

SP.FieldCollection

R

Нет

Получает значение, указывающее коллекцию всех полей, доступных в текущей области, включая типы текущего и всех родительских сайтов.

Configuration

Int16

R

Да

Получает идентификатор конфигурации определений сайтов, использованной для создания сайта, или идентификатор конфигурации определений сайтов, которая лежит в основе шаблона сайта, с которого создавался сайт.

ContentTypes

SP.ContentTypeCollection

R

Нет

Получает коллекцию типов контента для веб-сайта.

Created

DateTime

R

Да

Получает значение, задающее время создания сайта.

CurrentUser

SP.User

R

Нет

Получает текущего пользователя сайта.

CustomMasterUrl

String

RW

Да

Получает или задает URL-адрес файла настраиваемой главной страницы, применяемый к веб-сайту.

Описание

String

RW

Да

Получает или задает описание сайта.

DesignerDownloadUrlForCurrentUser

String

R

Нет

Возвращает URL-адрес, по которому текущий пользователь может загрузить SharePoint Designer.

DocumentLibraryCalloutOfficeWebAppPreviewersDisabled

Boolean

R

Да

Определяет, включены ли средства предварительного просмотра WAC выноски библиотеки документов.

EffectiveBasePermissions

SP.BasePermissions

R

Нет

Представляет пересечение разрешений субъекта приложения и субъекта-пользователя. В случае только для приложений это свойство возвращает разрешения субъекта приложения.

Чтобы проверить только разрешения пользователя (без учета разрешений приложения), используйте метод GetUserEffectivePermissions.

EnableMinimalDownload

Boolean

RW

Да

Получает или задает логическое значение, указывающее, следует ли использовать на веб-сайте стратегию минимальной загрузки.

EventReceivers

SP.EventReceiverCollection

R

Нет

Получает коллекцию определений приемников событий, в настоящее время доступных на веб-сайте.

Features

SP.FeatureCollection

R

Нет

Получает значение, задающее коллекцию функций, активных сейчас на сайте.

Fields

SP.FieldCollection

R

Нет

Получает коллекцию объектов полей, представляющую все поля веб-сайта.

Folders

SP.FolderCollection

R

Нет

Получает коллекцию всех папок первого уровня на веб-сайте.

Id

GUID

R

Да

Получает значение, задающее идентификатор сайта.

Language

Int32

R

Да

Получает значение, которое задает код языка, используемого на сайте.

LastItemModifiedDate

DateTime

R

Да

Получает значение, задающее время последнего изменения элемента.

Lists

SP.ListCollection

R

Нет

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

ListTemplates

SP.ListTemplateCollection

R

Нет

Получает значение, задающее коллекцию определений и шаблонов списков, доступных для создания списков на сайте.

MasterUrl

String

RW

Да

Получает или задает URL-адрес главной страницы, используемой для веб-сайта.

Навигация

SP.Navigation

R

Нет

Получает значение, задающее структуру навигации сайта, включая панель быстрого запуска и верхнюю панель навигации.

ParentWeb

SP.Web

R

Нет

Получает родительский веб-сайт указанного веб-сайта.

PushNotificationSubscribers

SP.PushNotificationSubscriberCollection

R

Нет

Получает коллекцию подписчиков push-уведомлений на сайте.

QuickLaunchEnabled

Boolean

RW

Да

Получает или задает значение, указывающее, включена ли панель быстрого запуска на сайте.

RecycleBin

SP.RecycleBin

R

Нет

Задает коллекцию элементов корзины сайта.

RecycleBinEnabled

Boolean

R

Да

Получает или задает значение, указывающее, включена ли корзина для веб-сайта.

RegionalSettings

SP.RegionalSettings

R

Нет

Получает региональные параметры, в настоящее время реализованные на веб-сайте.

RoleDefinitions

SP.RoleDefinitionCollection

R

Нет

Получает коллекцию определений ролей для веб-сайта.

RootFolder

SP.Folder

R

Нет

Получает корневую папку веб-сайта.

SaveSiteAsTemplateEnabled

Boolean

RW

Нет

Получает или задает логическое значение, указывающее, можно ли сохранить веб-сайт как шаблон сайта.

ServerRelativeUrl

String

RW

Да

Получает или задает зависящий от сервера URL-адрес веб-сайта.

ShowUrlStructureForCurrentUser

Boolean

R

Нет

Получает значение, указывающее, может ли текущий пользователь просматривать структуру файловой системы данного сайта.

SiteGroups

SP.GroupCollection

R

Нет

Получает коллекцию групп для семейства веб-сайтов.

SiteUserInfoList

SP.List

R

Нет

Получает список UserInfo для семейства, содержащего веб-сайт.

SiteUsers

SP.UserCollection

R

Нет

Получает коллекции всех пользователей, которые принадлежат семейству веб-сайтов.

SupportedUILanguageIds

Collection(Int32)

R

Нет

Указывает коды языков (LCID), включенных для сайта.

SyndicationEnabled

Boolean

RW

Да

Получает или задает значение, указывающее, включены ли RSS-каналы на сайте.

ThemeInfo

SP.ThemeInfo

R

Нет

Сведения о темах для данного сайта, включая информацию о цветах, шрифтах, радиусах границ и т. д.

Title

String

RW

Да

Получает или задает заголовок веб-сайта.

TreeViewEnabled

Boolean

RW

Да

Получает или задает значение, указывающее, включено ли на сайте представление в виде дерева.

UIVersion

Int32

RW

Да

Получает или задает версию пользовательского интерфейса веб-сайта.

UIVersionConfigurationEnabled

Boolean

RW

Да

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

Url

String

R

Да

Получает абсолютный URL-адрес веб-сайта.

UserCustomActions

SP.UserCustomActionCollection

R

Нет

Получает значение, задающее коллекцию пользовательских дополнительных действий сайта.

WebInfos

SP.WebInformation

R

Нет

Представляет основные свойства дочерних сайтов указанного сайта.

Webs

SP.ViewFieldCollection

R

Нет

Получает объект семейства веб-сайтов, представляющий все его непосредственные дочерние веб-сайты, но не их дочерние веб-сайты.

WebTemplate

String

R

Да

Получает имя определения или шаблона сайта, который использовался для создания сайта.

WorkflowAssociations

SP.WorkflowAssociationCollection

R

Нет

Получает значение, задающее коллекцию всех сопоставлений рабочих процессов на сайте.

WorkflowTemplates

SP.WorkflowTemplateCollection

R

Нет

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

Методы Web

ApplyTheme
ApplyWebTemplate
BreakRoleInheritance
DeleteObject
DoesPushNotificationSubscriberExist
DoesUserHavePermissions
EnsureUser
ExecuteRemoteLOB
GetAppBdcCatalog
GetAppBdcCatalogForAppInstance
GetAppInstanceById
GetAppInstancesByProductId
GetAvailableWebTemplates
GetCatalog
GetChanges
GetContextWebInformation
GetEntity
GetDocumentLibraries
GetFileByServerRelativeUrl
GetFolderByServerRelativeUrl
GetList
GetPushNotificationSubscriber
GetPushNotificationSubscribersByArgs
GetPushNotificationSubscribersByUser
GetSubwebsFilteredForCurrentUser
GetUserById
GetUserEffectivePermissions
GetWebUrlFromPageUrl
LoadAndInstallApp
LoadAndInstallAppInSpecifiedLocale
LoadApp
MapsToIcon
ProcessExternalNotification
RegisterPushNotificationSubscriber
ResetRoleInheritance
UnregisterPushNotificationSubscriber

Метод ApplyTheme

Применяет тему, которая указана в содержимом каждого из файлов, заданных в аргументах для сайта.

Конечная точка

/applytheme(colorpaletteurl, fontschemeurl, backgroundimageurl, sharegenerated)

Параметры

colorpaletteurl

Тип: String
Зависящий от сервера URL-адрес файла цветовой палитры.

fontschemeurl

Тип: String
Зависящий от сервера URL-адрес шрифтовой схемы.

backgroundimageurl

Тип: String
Зависящий от сервера URL-адрес фонового изображения.

sharegenerated

Тип: Boolean
true для хранения созданных файлов темы на корневом сайте, или значение false для их хранения на этом сайте.

HTTP method

POST

Ответ

Нет

  Пример запроса

$.ajax({
  url: "http://<site url>/_api/web
    /applytheme(colorpaletteurl='/_catalogs/theme/15/palette011.spcolor',
        fontschemeurl='/_catalogs/theme/15/fontscheme007.spfont',
        backgroundimageurl='/piclibrary/th.jpg', sharegenerated=true)",
  type: "POST",
  headers: { "X-RequestDigest": <form digest value> },
  success: successHandler,
  error: errorHandler
});

Или же можно отправить параметры в тексте запроса: { 'colorPaletteUrl':'/_catalogs/theme/15/palette011.spcolor', 'fontSchemeUrl':'/_catalogs/theme/15/fontscheme007.spfont', 'backgroundImageUrl':'/piclibrary/pics/th.jpg', 'shareGenerated':true }

См. статью Общие сведения о темах для SharePoint 2013.

Метод ApplyWebTemplate

Применяет указанное определение или шаблон сайта к веб-сайту, у которого нет примененного шаблона.

Примечание

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

Конечная точка

/applywebtemplate('<определение сайта или имя веб-шаблона>')

Параметры

Тип: String
Имя определения сайта или шаблона сайта. Используйте метод GetAvailableWebTemplates для получения имен доступных шаблонов сайта.

HTTP method

POST

Ответ

Нет

  Пример запроса

$.ajax({
  url: "http://<site url>/_api/web
    /applywebtemplate(@v)?@v='blog%230'",
  type: "POST",
  headers: { "X-RequestDigest": <form digest value> },
  success: successHandler,
  error: errorHandler
});

Метод BreakRoleInheritance

Создает уникальные назначения ролей для защищаемого объекта.

Конечная точка

/breakroleinheritance(copyroleassignments, clearsubscopes)

Параметры

copyroleassignments

Тип: Boolean
true для копирования назначений ролей из родительского защищаемого объекта. false — для удаления всех наследуемых назначений ролей, кроме назначения, содержащего текущего пользователя.

clearsubscopes

Тип: Boolean
. Необязательный параметр. Значение true, чтобы все дочерние защищаемые объекты наследовали назначения ролей от текущего объекта; значение false (по умолчанию), чтобы не изменять назначения ролей для дочерних защищаемых объектов, которые не наследуют назначения ролей от родительского объекта.

HTTP method

POST

Ответ

Нет

  Пример запроса

$.ajax({
  url: "http://<site url>/_api/web
    /breakroleinheritance(copyroleassignments=false, clearsubscopes=true)",
  method: "POST",
  headers: { "X-RequestDigest": <form digest value> },
  success: successHandler,
  error: errorHandler
});

Метод DeleteObject

Примеры

Метод DoesPushNotificationSubscriberExist

Проверяет, имеется ли подписчик push-уведомлений для текущего пользователя с данным идентификатором экземпляра приложения устройства.

Конечная точка

/doespushnotificationsubscriberexist('<идентификатор экземпляра приложения для устройства>')

Параметры

Тип: GUID
Идентификатор экземпляра приложения для устройства.

HTTP method

GET

Ответ

Тип: Boolean
true, если подписка существует; в противном случае — значение false.

Метод DoesUserHavePermissions

Возвращает результат, указывающий, есть ли у текущего пользователя данный набор разрешений.

Конечная точка

/doesuserhavepermissions(@v)?@v={'High':'<значение>', 'Low':'<значение>'}

Параметры

Тип: SP.BasePermissions
Верхний и нижний диапазон разрешений. Используйте конечную точку …/_api/web/roledefinitions для получения значений верхнего и нижнего диапазона разрешений для ролей сайта.

HTTP method

GET

Ответ

Тип: Boolean
true, если у пользователя есть разрешения; в противном случае — значение false.

  Пример запроса

$.ajax({
  url: "http://<site url>/_api/web
    /doesuserhavepermissions(@v)?@v={'High':'432', 'Low':'1012866047'}",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Метод EnsureUser

Проверяет, принадлежит ли указанное имя входа допустимому пользователю сайта. Если пользователь не существует, добавляет пользователя на сайт.

Конечная точка

/ensureuser

Параметры

logonName

Тип: String
Имя входа пользователя. Передайте параметр logonName в тексте запроса, как показано в примере запроса.

HTTP method

POST

Ответ

Тип: SP.User
Указанный пользователь.

  Пример запроса

$.ajax({
  url: "http://<site url>/_api/web
    /ensureuser",
  type: "POST",
  data: "{ 'logonName': 'i:0#.f|membership|user@domain.onmicrosoft.com' }",
  headers: {
    "X-RequestDigest": <form digest value>,
    "accept": "application/json;odata=verbose"
  },
  success: successHandler,
  error: errorHandler
});

Метод ExecuteRemoteLOB

Отправляет данные службе OData.

Этот метод является точкой входа для гибридных подключений и используется для вызова службы OData на локальном сервере. Входные параметры, необходимые для вызова службы OData, передаются как настраиваемые HTTP-заголовки. См. статью ExecuteRemoteLOB.

Конечная точка

/executeremotelob

Параметры

inputStream

Тип: Stream
Входной объект OData. Используется только для операций создания или обновления.

HTTP method

POST

Ответ

Тип: Stream
Ответ OData от службы OData.

Метод GetAppBdcCatalog

Конечная точка

/getappbdccatalog

Параметры

Нет

HTTP method

POST

Ответ

Тип: SP.BusinessData.AppBdcCatalog
MetadataCatalog Служба подключения к бизнес-данным (BDC) для текущего экземпляра приложения.

Метод GetAppBdcCatalogForAppInstance

Конечная точка

/getappbdccatalogforappinstance('<идентификатор экземпляра приложения>')

Параметры

Тип: GUID
Идентификатор экземпляра приложения.

HTTP method

POST

Ответ

Тип: SP.BusinessData.AppBdcCatalog
MetadataCatalog BDC для указанного экземпляра приложения.

Метод GetAppInstanceById

Извлекает AppInstance, установленный на данном сайте.

Конечная точка

/getappinstancebyid('<идентификатор экземпляра приложения>')

Параметры

Тип: GUID
Идентификатор экземпляра приложения.

HTTP method

GET

Ответ

Тип: SP.AppInstance
Указанный экземпляр приложения.

  Пример запроса

$.ajax({
  url: "http://<site url>/_api/web
    /getappinstancebyid('3122ea58-8435-4d9a-a302-345599838671')",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Метод GetAppInstancesByProductId

Извлекает все AppInstance, установленные на данном сайте и являющиеся экземплярами указанного приложения.

Конечная точка

/getappinstancesbyproductid('<идентификатор продукта>')

Параметры

Тип: GUID
Идентификатор продукта приложения.

HTTP method

GET

Ответ

Тип: Collection(SP.AppInstance)
Экземпляры приложения, установленные на сайте для указанного продукта.

Метод GetAvailableWebTemplates

Возвращает коллекцию шаблонов сайтов, доступных для сайта.

Конечная точка

/getavailablewebtemplates(lcid, doincludecrosslanguage)

Параметры

lcid

Тип: Int64
Код языка шаблонов сайта, которые необходимо получить.

doincludecrosslanguage

Тип: Boolean
Значение true для включения не зависящих от языка шаблонов сайта; в противном случае — значение false.

HTTP method

GET

Ответ

Тип: SP.WebTemplateCollection
Коллекция доступных шаблонов сайтов. Возвращает пустую коллекцию, если указан недопустимый код языка.

  Пример запроса

$.ajax({
  url: "http://<site url>/_api/web
    /getavailablewebtemplates(lcid=1033, doincludecrosslanguage=true)",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Метод GetCatalog

Возвращает коллекцию списков на сайте.

Конечная точка

/getcatalog(<тип коллекции>)

Параметры

Тип: Int32
Тип коллекции. Представляет значение типа ListTemplateType, например WebTemplateCatalog = 111, WebPartCatalog = 113 ListTemplateCatalog = 114, MasterPageCatalog = 116, SolutionCatalog = 121, ThemeCatalog = 123, DesignCatalog = 124, AppDataCatalog = 125.

HTTP method

GET

Ответ

Тип: SP.List
Коллекция для указанного типа списка. Возвращает значение null, если коллекция с указанным типом не существует или задан недопустимый тип шаблона списка.

  Пример запроса

$.ajax({
  url: "http://<site url>/_api/web
    /getcatalog(113)",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Метод GetChanges

Возвращает по указанному запросу коллекцию всех изменений из журнала, которые происходили в области сайта.

Конечная точка

/getchanges

Параметры

query

Тип: SP.ChangeQuery
Запрос изменения. Передайте параметр query в тексте запроса, как показано в примере запроса.

HTTP method

POST

Ответ

Тип: SP.ChangeCollection
Изменения сайта, соответствующие критериям указанного запроса изменения.

  Пример запроса

$.ajax({
  url: "http://<site url>/_api/web
    /getchanges",
  type: "POST",
  data: "{ 'query': { '__metadata': { 'type': 'SP.ChangeQuery' },
    'Web': true, 'Update': true, 'Add': true } }",
  headers: {
    "X-RequestDigest": <form digest value>
    "accept": "application/json;odata=verbose",
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>
  },
  success: successHandler,
  error: errorHandler
});

GetContextWebInformation

Получает сведения о контексте для сайта. Статический метод.

Конечная точка

http://<URL-адрес сайта>/_api/contextinfo

Параметры

Нет

HTTP method

POST

Ответ

Тип: SP.ContextWebInformation
Сведения о контексте для сайта.

  Пример запроса

$.ajax({
  url: "http://<site url>/_api
    /contextinfo",
  type: "POST",
  headers: {
    "X-RequestDigest": <form digest value>,
    "accept": "application/json;odata=verbose"
  },
  success: successHandler,
  error: errorHandler
});

Метод GetCustomListTemplates

Получает настраиваемые шаблоны списка для сайта.

Конечная точка

/getcustomlisttemplates

Параметры

Нет

HTTP method

GET

Ответ

Тип: SP.ListTemplateCollection
Настраиваемые шаблоны списка для сайта.

  Пример запроса

$.ajax({
  url: "http://<site url>/_api/web
    /getcustomlisttemplates",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Метод GetDocumentLibraries

Получает библиотеки документов на сайте. Статический метод. (Только для SharePoint Online.)

Конечная точка

http://<URL-адрес сайта>/_api/sp.web.getdocumentlibraries(@v)?@v='<полный URL-адрес сайта>'

Параметры

Тип: String
Полный URL-адрес сайта.

HTTP method

GET

Ответ

Тип: Collection(SP.DocumentLibraryInformation)
Свойства библиотек документов на сайте. Этот метод не возвращает частные библиотеки, библиотеки изображений, библиотеки каталогов, библиотеки активов, списки приложений или библиотеки, для просмотра которых у пользователя нет разрешений.

  Пример запроса

$.ajax({
  url: "http://<site url>/_api
    /sp.web.getdocumentlibraries(@v)?@v='https://contoso.sharepoint.com'",
  method: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler});

Метод GetEntity

Получает указанный внешний тип контента в бизнес-приложении.

Конечная точка

/getentity(namespace, name)

Параметры

namespace

Тип: String
Пространство имен для внешнего типа контента.

name

Тип: String
Имя внешнего типа контента.

HTTP method

POST

Ответ

Тип: SP.BusinessData.Entity
Внешний тип контента.

Метод GetFileByServerRelativeUrl

Возвращает объект файла, расположенного по указанному зависящему от сервера URL-адресу.

Конечная точка

/getfilebyserverrelativeurl('<зависящий от сервера URL-адрес>')

Параметры

Тип: String
Зависящий от сервера URL-адрес файла.

HTTP method

GET

Ответ

Тип: SP.File
Указанный файл.

  Пример запроса

$.ajax({
  url: "http://<site url>/_api/web
    /getfilebyserverrelativeurl('/templates/ResourceRequest.docx')",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Метод GetFolderByServerRelativeUrl

Возвращает объект папки, расположенной по указанному зависящему от сервера URL-адресу.

Конечная точка

/getfolderbyserverrelativeurl('<зависящий от сервера URL-адрес>')

Параметры

Тип: String
Зависящий от сервера URL-адрес папки.

HTTP method

GET

Ответ

Тип: SP.Folder
Указанная папка.

  Пример запроса

$.ajax({
  url: "http://<site url>/_api/web
    /getfolderbyserverrelativeurl('/templates/test')",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Метод GetList

Получает список по указанному связанному с сайтом URL-адресу.

Конечная точка

/getlist('<URL-адрес списка>')

Параметры

Тип: String
Зависящий от сайта URL-адрес списка.

HTTP method

GET

Ответ

Тип: SP.List
Указанный список.

  Пример запроса

$.ajax({
  url: "http://<site url>/_api/web
    /getlist('/lists/ideas')",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Метод GetPushNotificationSubscriber

Получает подписчика push-уведомлений на сайте для указанного идентификатора экземпляра приложения устройства.

Конечная точка

/getpushnotificationsubscriber('<идентификатор экземпляра приложения для устройства>')

Параметры

Тип: GUID
Идентификатор экземпляра приложения для устройства.

HTTP method

GET

Ответ

Тип: SP.PushNotificationSubscriber
Зарегистрированный подписчик на push-уведомления.

Метод GetPushNotificationSubscribersByArgs

Запрашивает у подписчиков push-уведомлений на сайте указанное значение настраиваемых аргументов. Настраиваемые аргументы со значением Null или пустые настраиваемые аргументы будут возвращать подписчиков без фильтрации.

Конечная точка

/getpushnotificationsubscribersbyargs('<аргументы>')

Параметры

Тип: String
Аргументы для фильтрации результатов. Переданные аргументы сравниваются с настраиваемыми аргументами подписчика в хранилище. Передайте значение null или пустые аргументы, чтобы получить нефильтрованные результаты.

HTTP method

GET

Ответ

Тип: SP.PushNotificationSubscriberCollection
Зарегистрированные подписчики на push-уведомления, соответствующие аргументам. Если совпадения не найдены, возвращается пустая коллекция.

Метод GetPushNotificationSubscribersByUser

Запрашивает у подписчиков push-уведомлений на сайте указанное значение настраиваемого пользователя.

Конечная точка

/getpushnotificationsubscribersbyuser(@v)?@v='<имя для входа>'

Параметры

Тип: String
Имя входа пользователя. Сведения о форматах, используемых для передачи имен входа в строке запроса, см. в разделе Пользователь.

HTTP method

GET

Ответ

Тип: SP.PushNotificationSubscriberCollection
Зарегистрированные подписчики на push-уведомления для пользователя.

Метод GetSubwebsFilteredForCurrentUser

Возвращает коллекцию дочерних сайтов текущего сайта по указанному запросу.

Доступен только в SharePoint Online.

Конечная точка

/getsubwebsfilteredforcurrentuser(nwebtemplatefilter, nconfigurationfilter)

Параметры

nwebtemplatefilter

Тип: Int32
Идентификатор шаблона, используемый для определения сайтов.

nconfigurationfilter

Тип: Int16
Идентификатор шаблона, используемый для подготовки сайтов.

HTTP method

GET

Ответ

Тип: Collection(SP.WebInformation)
Сведения о сайтах, доступных текущему пользователю.

  Пример запроса

$.ajax({
  url: "http://<site url>/_api/web
    /getsubwebsfilteredforcurrentuser(nwebtemplatefilter=-1,nconfigurationfilter=0)",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Метод GetUserById

Возвращает пользователя, соответствующего указанному идентификатору участника для текущего сайта.

Конечная точка

/getuserbyid(<идентификатор пользователя>)

Параметры

Тип: Int32
Идентификатор пользователя.

HTTP method

GET

Ответ

Тип: SP.User
Указанный пользователь.

  Пример запроса

$.ajax({
  url: "http://<site url>/_api/web
    /getuserbyid(12)",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Метод GetUserEffectivePermissions

Получает эффективные разрешения указанного пользователя в пределах области текущего приложения.

Для проверки разрешений пользователя, отличного от текущего, у приложений должны быть разрешения Full Control для сайта.

Конечная точка

/getusereffectivepermissions(@v)?@v='<имя для входа>'

Параметры

Тип: String
Имя входа пользователя. Сведения о форматах, используемых для передачи имен входа в строке запроса, см. в разделе Пользователь.

HTTP method

GET

Ответ

Тип: SP.BasePermissions
Разрешения указанного пользователя.

  Пример запроса

$.ajax({
  url: "http://<site url>/_api/web
    /getusereffectivepermissions(@v)?@v='i%3A0%23.f%7Cmembership%7Cuser%40domain.onmicrosoft.com'",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Метод GetWebUrlFromPageUrl

Получает URL-адрес из URL-адреса страницы. Статический метод.

Конечная точка

http://<URL-адрес сайта>/_api/sp.web.getweburlfrompageurl(@v)?@v='<полный URL-адрес страницы>'

Параметры

Тип: String
Полный URL-адрес страницы SharePoint с закодированными символами URL-адреса при необходимости.

HTTP method

GET

Ответ

Тип: String
Полный URL-адрес сайта SharePoint.

  Пример запроса

$.ajax({
  url: "http://<site url>/_api
    /sp.web.getweburlfrompageurl(@v)?@v='https://contoso.sharepoint.com/subsite/_layouts/15/start.aspx'",
  method: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Метод LoadAndInstallApp

Передает и устанавливает пакет приложений на данном сайте.

Этот сайт должен быть включен для удаленной разработки.

Конечная точка

/loadandinstallapp

Параметры

appPackageStream

Тип: Stream
Поток пакета приложения.

Метод HTTP

POST

Ответ

Тип: SP.AppInstance
Экземпляр приложения.

Метод LoadAndInstallAppInSpecifiedLocale

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

Конечная точка

/loadandinstallappinspecifiedlocale

Параметры

appPackageStream

Тип: Stream
Поток пакета приложения.

installationLocaleLCID

Тип: Int32
Код языка, который будет использован для создания экземпляра приложения.

HTTP method

POST

Ответ

Тип: SP.AppInstance
Экземпляр приложения.

Метод LoadApp

Передает пакет приложений и создает экземпляр на его основе.

Конечная точка

/loadapp

Параметры

appPackageStream

Тип: Stream
Поток пакета приложения.

installationLocaleLCID

Тип: Int32
Код языка, который будет использован для создания экземпляра приложения.

HTTP method

POST

Ответ

Тип: SP.AppInstance
Экземпляр приложения.

Метод MapToIcon

Возвращает имя файла значка, который используется для представления указанного файла.

Конечная точка

/maptoicon(filename, progid, size)

Параметры

filename

Тип: String
Имя файла. Если параметр пуст, сервер возвращает пустую строку.

progid

Тип: String
ProgID приложения, которое использовалось для создания файла, в формате OLEServerName.ObjectName (например, Excel.Sheet или PowerPoint.Slide). Это идентификатор, используемый в реестре Windows для уникальной идентификации объекта.

size

Тип: Int32
Размер значка: 16 x 16 пикселей = 0; 32 x 32 пикселя = 1.

HTTP method

GET

Ответ

Тип: String
Имя файла изображения значка.

  Пример запроса

$.ajax({
  url: "http://<site url>/_api/web
    /maptoicon(filename='spectemplate.docx', progid='', size=0)",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Метод ProcessExternalNotification

Обрабатывает уведомление от внешней системы.

Конечная точка

/processexternalnotification

Параметры

stream

Тип: Stream
Уведомление от внешней системы.

HTTP method

POST

Ответ

Тип: String
Предшествующее состояние: Success указывает на успешную обработку, SubscriptionNotRequired указывает на то, что подписка более не требуется и может быть удалена.

Метод RegisterPushNotificationSubscriber

Регистрирует подписчика для получения push-уведомлений на сайте. Если регистрация уже выполнена, маркер службы обновляется с использованием нового значения.

Конечная точка

/registerpushnotificationsubscriber(deviceappinstanceid, servicetoken)

Параметры

deviceappinstanceid

Тип: GUID
Идентификатор экземпляра приложения для устройства.

servicetoken

Тип: String
Маркер, предоставленный службой уведомлений устройству для получения уведомлений.

HTTP method

POST

Ответ

Тип: SP.PushNotificationSubscriber
Зарегистрированный подписчик на push-уведомления.

Метод ResetRoleInheritance

Сбрасывает наследование ролей для защищаемого объекта и берет их из родительского защищаемого объекта.

Конечная точка

/resetroleinheritance

Параметры

Нет

HTTP method

POST

Ответ

Нет

  Пример запроса

$.ajax({
  url: "http://<site url>/_api/web
    /resetroleinheritance",
  method: "POST",
  headers: { "X-RequestDigest": <form digest value> },
  success: successHandler,
  error: errorHandler
});

Метод UnregisterPushNotificationSubscriber

Отменяет регистрацию подписчика на получение push-уведомлений с сайта.

Конечная точка

/unregisterpushnotificationsubscriber('<идентификатор экземпляра приложения для устройства>')

Параметры

Тип: GUID
Идентификатор экземпляра приложения для устройства.

HTTP method

POST

Ответ

Нет

Представление OData

В примере ниже ресурс Web представлен в формате JSON.

    {"d":{
      "__metadata":{
        "id":"https://<site url>/_api/Web",
        "uri":"https://<site url>/_api/Web",
        "type":"SP.Web"
      },
      "FirstUniqueAncestorSecurableObject":{"__deferred":{"uri":"https://<site url>/_api/Web/FirstUniqueAncestorSecurableObject"}},
      "RoleAssignments":{"__deferred":{"uri":"https://<site url>/_api/Web/RoleAssignments"}},
      "AllProperties":{"__deferred":{"uri":"https://<site url>/_api/Web/AllProperties"}},
      "AssociatedMemberGroup":{"__deferred":{"uri":"https://<site url>/_api/Web/AssociatedMemberGroup"}},
      "AssociatedOwnerGroup":{"__deferred":{"uri":"https://<site url>/_api/Web/AssociatedOwnerGroup"}},
      "AssociatedVisitorGroup":{"__deferred":{"uri":"https://<site url>/_api/Web/AssociatedVisitorGroup"}},
      "AvailableContentTypes":{"__deferred":{"uri":"https://<site url>/_api/Web/AvailableContentTypes"}},
      "AvailableFields":{"__deferred":{"uri":"https://<site url>/_api/Web/AvailableFields"}},
      "ContentTypes":{"__deferred":{"uri":"https://<site url>/_api/Web/ContentTypes"}},
      "CurrentUser":{"__deferred":{"uri":"https://<site url>/_api/Web/CurrentUser"}},
      "DescriptionResource":{"__deferred":{"uri":"https://<site url>/_api/Web/DescriptionResource"}},
      "EventReceivers":{"__deferred":{"uri":"https://<site url>/_api/Web/EventReceivers"}},
      "Features":{"__deferred":{"uri":"https://<site url>/_api/Web/Features"}},
      "Fields":{"__deferred":{"uri":"https://<site url>/_api/Web/Fields"}},
      "Folders":{"__deferred":{"uri":"https://<site url>/_api/Web/Folders"}},
      "Lists":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists"}},
      "ListTemplates":{"__deferred":{"uri":"https://<site url>/_api/Web/ListTemplates"}},
      "Navigation":{"__deferred":{"uri":"https://<site url>/_api/Web/Navigation"}},
      "ParentWeb":{"__deferred":{"uri":"https://<site url>/_api/Web/ParentWeb"}},
      "PushNotificationSubscribers":{"__deferred":{"uri":"https://<site url>/_api/Web/PushNotificationSubscribers"}},
      "RecycleBin":{"__deferred":{"uri":"https://<site url>/_api/Web/RecycleBin"}},
      "RegionalSettings":{"__deferred":{"uri":"https://<site url>/_api/Web/RegionalSettings"}},
      "RoleDefinitions":{"__deferred":{"uri":"https://<site url>/_api/Web/RoleDefinitions"}},
      "RootFolder":{"__deferred":{"uri":"https://<site url>/_api/Web/RootFolder"}},
      "SiteGroups":{"__deferred":{"uri":"https://<site url>/_api/Web/SiteGroups"}},
      "SiteUserInfoList":{"__deferred":{"uri":"https://<site url>/_api/Web/SiteUserInfoList"}},
      "SiteUsers":{"__deferred":{"uri":"https://<site url>/_api/Web/SiteUsers"}},
      "ThemeInfo":{"__deferred":{"uri":"https://<site url>/_api/Web/ThemeInfo"}},
      "TitleResource":{"__deferred":{"uri":"https://<site url>/_api/Web/TitleResource"}},
      "UserCustomActions":{"__deferred":{"uri":"https://<site url>/_api/Web/UserCustomActions"}},
      "Webs":{"__deferred":{"uri":"https://<site url>/_api/Web/Webs"}},
      "WebInfos":{"__deferred":{"uri":"https://<site url>/_api/Web/WebInfos"}},
      "WorkflowAssociations":{"__deferred":{"uri":"https://<site url>/_api/Web/WorkflowAssociations"}},
      "WorkflowTemplates":{"__deferred":{"uri":"https://<site url>/_api/Web/WorkflowTemplates"}},
      "AllowRssFeeds":true,
      "AppInstanceId":"d025f690-8281-4cb7-ab11-04793e232661",
      "Configuration":0,
      "Created":"2014-02-27T20:08:25",
      "CustomMasterUrl":"/_catalogs/masterpage/app.master",
      "Description":"",
      "DocumentLibraryCalloutOfficeWebAppPreviewersDisabled":false,
      "EnableMinimalDownload":false,
      "Id":"ba0bfd3d-ba13-4400-aacf-f60d56eecfbc",
      "Language":1033,
      "LastItemModifiedDate":"2014-02-27T20:08:28Z",
      "MasterUrl":"/_catalogs/masterpage/app.master",
      "QuickLaunchEnabled":true,
      "RecycleBinEnabled":true,
      "ServerRelativeUrl":"",
      "SyndicationEnabled":true,
      "Title":"ParseUm",
      "TreeViewEnabled":false,
      "UIVersion":15,
      "UIVersionConfigurationEnabled":false,
      "Url":"https://<site url>",
      "WebTemplate":"APP"
    }}

Ресурс WebCollection

URI конечной точки  |  Методы  |  Представление OData

Представляет коллекцию сайтов.

URI конечной точки

http://<URL-адрес сайта>/_api/web/webs

Поддерживаемые методы HTTP-запросов

GET  |  POST

Примеры запросов

Пример запроса GET: получение всех дочерних сайтов указанного сайта

$.ajax({
  url: "http://<site url>/_api/web/webs",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Пример запроса POST: создание сайта с использованием метода Add.

$.ajax({
  url: "http://<site url>/_api/web/webs/add",
  type: "POST",
  data: "{ 'parameters': { '__metadata': { 'type': 'SP.WebCreationInformation' },
    'Title': 'Social Meetup', 'Url': 'social', 'WebTemplate': 'MPS#3',
    'UseSamePermissionsAsParentSite': true } }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "accept": "application/json;odata=verbose",
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>
  },
  success: successHandler,
  error: errorHandler
});

Или же можно воспользоваться методом Add ресурса WebInformationCollection, как показано в разделе Создание сайта с помощью REST.

Примеры

Методы WebCollection

Add

Метод Add

Добавляет в коллекцию новый веб-сайт.

Конечная точка

/add

Параметры

parameters

Тип: SP.WebCreationInformation
Свойства нового сайта. Отправьте этот параметр в тексте запроса, как показано в примере запроса.

HTTP method

POST

Ответ

Тип: SP.Web
Новый сайт.

  Пример запроса

$.ajax({
  url: "http://<site url>/_api/web/webs
    /add",
  type: "POST",
  data: "{ 'parameters': { '__metadata': { 'type': 'SP.WebCreationInformation' },
    'Title': 'Social Meetup', 'Url': 'social', 'WebTemplate': 'MPS#3',
    'UseSamePermissionsAsParentSite': true } }",
  headers: {
    "X-RequestDigest": <form digest value>,
    "accept": "application/json;odata=verbose",
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>
  },
  success: successHandler,
  error: errorHandler
});

Используйте метод GetAvailableWebTemplates для получения имен доступных шаблонов сайта.

Представление OData

В следующем примере ресурс WebCollection представлен в формате JSON.

    {"d":{
      "results":[{
          "__metadata":{
            "id":"https://<site url>/_api/Web",
            "uri":"https://<site url>/_api/Web",
            "type":"SP.Web"
          },
          "FirstUniqueAncestorSecurableObject":{"__deferred":{"uri":"https://<site url>/_api/Web/FirstUniqueAncestorSecurableObject"}},
          "RoleAssignments":{"__deferred":{"uri":"https://<site url>/_api/Web/RoleAssignments"}},
          "AllProperties":{"__deferred":{"uri":"https://<site url>/_api/Web/AllProperties"}},
          "AssociatedMemberGroup":{"__deferred":{"uri":"https://<site url>/_api/Web/AssociatedMemberGroup"}},
          "AssociatedOwnerGroup":{"__deferred":{"uri":"https://<site url>/_api/Web/AssociatedOwnerGroup"}},
          "AssociatedVisitorGroup":{"__deferred":{"uri":"https://<site url>/_api/Web/AssociatedVisitorGroup"}},
          "AvailableContentTypes":{"__deferred":{"uri":"https://<site url>/_api/Web/AvailableContentTypes"}},
          "AvailableFields":{"__deferred":{"uri":"https://<site url>/_api/Web/AvailableFields"}},
          "ContentTypes":{"__deferred":{"uri":"https://<site url>/_api/Web/ContentTypes"}},
          "CurrentUser":{"__deferred":{"uri":"https://<site url>/_api/Web/CurrentUser"}},
          "DescriptionResource":{"__deferred":{"uri":"https://<site url>/_api/Web/DescriptionResource"}},
          "EventReceivers":{"__deferred":{"uri":"https://<site url>/_api/Web/EventReceivers"}},
          "Features":{"__deferred":{"uri":"https://<site url>/_api/Web/Features"}},
          "Fields":{"__deferred":{"uri":"https://<site url>/_api/Web/Fields"}},
          "Folders":{"__deferred":{"uri":"https://<site url>/_api/Web/Folders"}},
          "Lists":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists"}},
          "ListTemplates":{"__deferred":{"uri":"https://<site url>/_api/Web/ListTemplates"}},
          "Navigation":{"__deferred":{"uri":"https://<site url>/_api/Web/Navigation"}},
          "ParentWeb":{"__deferred":{"uri":"https://<site url>/_api/Web/ParentWeb"}},
          "PushNotificationSubscribers":{"__deferred":{"uri":"https://<site url>/_api/Web/PushNotificationSubscribers"}},
          "RecycleBin":{"__deferred":{"uri":"https://<site url>/_api/Web/RecycleBin"}},
          "RegionalSettings":{"__deferred":{"uri":"https://<site url>/_api/Web/RegionalSettings"}},
          "RoleDefinitions":{"__deferred":{"uri":"https://<site url>/_api/Web/RoleDefinitions"}},
          "RootFolder":{"__deferred":{"uri":"https://<site url>/_api/Web/RootFolder"}},
          "SiteGroups":{"__deferred":{"uri":"https://<site url>/_api/Web/SiteGroups"}},
          "SiteUserInfoList":{"__deferred":{"uri":"https://<site url>/_api/Web/SiteUserInfoList"}},
          "SiteUsers":{"__deferred":{"uri":"https://<site url>/_api/Web/SiteUsers"}},
          "ThemeInfo":{"__deferred":{"uri":"https://<site url>/_api/Web/ThemeInfo"}},
          "TitleResource":{"__deferred":{"uri":"https://<site url>/_api/Web/TitleResource"}},
          "UserCustomActions":{"__deferred":{"uri":"https://<site url>/_api/Web/UserCustomActions"}},
          "Webs":{"__deferred":{"uri":"https://<site url>/_api/Web/Webs"}},
          "WebInfos":{"__deferred":{"uri":"https://<site url>/_api/Web/WebInfos"}},
          "WorkflowAssociations":{"__deferred":{"uri":"https://<site url>/_api/Web/WorkflowAssociations"}},
          "WorkflowTemplates":{"__deferred":{"uri":"https://<site url>/_api/Web/WorkflowTemplates"}},
          "AllowRssFeeds":true,
          "AppInstanceId":"9f85a4a6-3609-44d6-9427-e7a5f16ceeeb",
          "Configuration":0,
          "Created":"2013-10-03T19:45:27",
          "CustomMasterUrl":"/apppart/_catalogs/masterpage/app.master",
          "Description":"",
          "DocumentLibraryCalloutOfficeWebAppPreviewersDisabled":false,
          "EnableMinimalDownload":false,
          "Id":"2dbf86de-6538-4d1a-b4fe-2a8e9816d692",
          "Language":1033,
          "LastItemModifiedDate":"2013-10-03T19:45:30Z",
          "MasterUrl":"/apppart/_catalogs/masterpage/app.master",
          "QuickLaunchEnabled":true,
          "RecycleBinEnabled":true,
          "ServerRelativeUrl":"/apppart",
          "SyndicationEnabled":true,
          "Title":"apppart",
          "TreeViewEnabled":false,
          "UIVersion":15,
          "UIVersionConfigurationEnabled":false,
          "Url":"https://<site url>",
          "WebTemplate":"APP"
        },{
        "__metadata":{
          "id":"https://<site url>,
          "uri":"https://<site url>,
          "type":"SP.Web"
        },
          "FirstUniqueAncestorSecurableObject":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/FirstUniqueAncestorSecurableObject"}},
          "RoleAssignments":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/RoleAssignments"}},
          "AllProperties":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/AllProperties"}},
          "AssociatedMemberGroup":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/AssociatedMemberGroup"}},
          "AssociatedOwnerGroup":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/AssociatedOwnerGroup"}},
          "AssociatedVisitorGroup":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/AssociatedVisitorGroup"}},
          "AvailableContentTypes":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/AvailableContentTypes"}},
          "AvailableFields":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/AvailableFields"}},
          "ContentTypes":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/ContentTypes"}},
          "CurrentUser":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/CurrentUser"}},
          "DescriptionResource":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/DescriptionResource"}},
          "EventReceivers":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/EventReceivers"}},
          "Features":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/Features"}},
          "Fields":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/Fields"}},
          "Folders":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/Folders"}},
          "Lists":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/Lists"}},
          "ListTemplates":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/ListTemplates"}},
          "Navigation":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/Navigation"}},
          "ParentWeb":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/ParentWeb"}},
          "PushNotificationSubscribers":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/PushNotificationSubscribers"}},
          "RecycleBin":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/RecycleBin"}},
          "RegionalSettings":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/RegionalSettings"}},
          "RoleDefinitions":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/RoleDefinitions"}},
          "RootFolder":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/RootFolder"}},
          "SiteGroups":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/SiteGroups"}},
          "SiteUserInfoList":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/SiteUserInfoList"}},
          "SiteUsers":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/SiteUsers"}},
          "ThemeInfo":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/ThemeInfo"}},
          "TitleResource":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/TitleResource"}},
          "UserCustomActions":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/UserCustomActions"}},
          "Webs":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/Webs"}},
          "WebInfos":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/WebInfos"}},
          "WorkflowAssociations":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/WorkflowAssociations"}},
          "WorkflowTemplates":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/WorkflowTemplates"}},
          "AllowRssFeeds":true,
          "AppInstanceId":"00000000-0000-0000-0000-000000000000",
          "Configuration":0,
          "Created":"2014-02-28T21:41:11",
          "CustomMasterUrl":"/TeamProjects/_catalogs/masterpage/seattle.master",
          "Description":"",
          "DocumentLibraryCalloutOfficeWebAppPreviewersDisabled":false,
          "EnableMinimalDownload":true,
          "Id":"3a37226d-8f0b-41bd-a720-6f63fd1e2abb",
          "Language":1033,
          "LastItemModifiedDate":"2014-02-28T21:41:23Z",
          "MasterUrl":"/TeamProjects/_catalogs/masterpage/seattle.master",
          "QuickLaunchEnabled":true,
          "RecycleBinEnabled":true,
          "ServerRelativeUrl":"/TeamProjects",
          "SyndicationEnabled":true,
          "Title":"Team projects",
          "TreeViewEnabled":false,
          "UIVersion":15,
          "UIVersionConfigurationEnabled":false,
          "Url":"https://<site url>/TeamProjects",
          "WebTemplate":"STS"
        },{
          ...
        }
      }]
    }}

Дополнительные ресурсы