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

Ознакомьтесь со списками, элементами списков, представлениями, а также другими ресурсами и конечными точками интерфейса API REST, связанными со списками.

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

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

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

В примерах запросов в данной статье предполагается, что вы используете междоменную библиотеку (SP.RequestExecutor.js) для выполнения междоменных запросов, поэтому в них применяется SP.AppContextSite в URI конечной точки. Дополнительные сведения см. в статье Обращение к данным SharePoint 2013 из надстроек с помощью междоменной библиотеки.

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

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

  • Если вы не используете междоменную библиотеку, добавьте заголовок X-RequestDigest для отправки значения дайджеста формы во все запросы POST и добавьте заголовок content-length для запросов POST, в тексте которых передаются данные.

  • Если вы не используете междоменные запросы, удалите SP.AppContextSite(@target) и ?@target='<host web url>' из URI конечной точки.

  • Если вы используете OAuth, добавьте заголовок Authorization ("Authorization": "Bearer " + <access token>), чтобы отправить маркер доступа OAuth.

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

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

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

Совет

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

Изучите синтаксис списков и элементов списка SharePoint 2013 службы REST

Изучите синтаксис списков и элементов списка службы REST

Визуально изучите синтаксис списков и элементов списков SharePoint 2013 в службе REST.

Изучите другие синтаксические диаграммы SharePoint REST:

Файлы и папки | Пользователи и группы

Скачайте объединенный PDF-файл со всеми синтаксическими диаграммами SharePoint REST.

Примечание

Параметр запроса OData $skip не работает при запросе элементов отдельного списка. Он работает при запросе конечной точки списков.

Ресурс List

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

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

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

http://<URL-адрес сайта>/web/lists(guid'<идентификатор списка>')

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

GET  |  POST  |  DELETE  |  MERGE  |  PUT

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

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

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Или же можно использовать метод GetByTitle ресурса ListCollection, чтобы получить список по его заголовку. Пример: …/web/lists/getbytitle('Access Requests').

Пример запроса POST: создание списка

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web/lists
    ?@target='<host web url>'",
  method: "POST",
  body: "{ '__metadata': { 'type': 'SP.List' }, 'AllowContentTypes': true, 'BaseTemplate': 100,
    'ContentTypesEnabled': true, 'Description': 'My list description', 'Title': 'Test title' }",
  headers: { "content-type": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

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

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')
    ?@target='<host web url>'",
  method: "POST",
  body: "{ '__metadata': { 'type': 'SP.List' }, 'AllowContentTypes': true, 'BaseTemplate': 100,
    'ContentTypesEnabled': true, 'Description': 'My list description', 'Title': 'Test title' }",
  headers: { 
    "IF-MATCH”: "*",
    "X-HTTP-Method": "MERGE",
    "content-type": "application/json;odata=verbose"
  },
  success: successHandler,
  error: errorHandler
});

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

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')
    ?@target='<host web url>'",
  method: "POST",
  headers: { 
    "IF-MATCH”: "*",
    "X-HTTP-Method": "DELETE"
  },
  success: successHandler,
  error: errorHandler
});

Если вы хотите удалить список и получить GUID элемента корзины, используйте метод Recycle списка, чтобы удалить файл.

Свойства List

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

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/<property name>
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Свойство

Тип

R/W

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

Описание

AllowContentTypes

Boolean

R

Да

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

BaseTemplate

Int32

R

Да

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

BaseType

Int32

R

Да

Получает базовый тип списка. Представляет значение SP.BaseType: общий список = 0; библиотека документов = 1; доска обсуждений = 3; опрос = 4; проблема = 5.

BrowserFileHandling

Int32

R

Нет

Получает значение, задающее переопределение свойства BrowserFileHandling веб-приложения на уровне списка. Представляет значение SP.BrowserFileHandling: нестрогое = 0; строгое = 1.

ContentTypes

SP.ContentTypeCollection

R

Нет

Получает типы контента, связанные со списком.

ContentTypesEnabled

Boolean

RW

Да

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

Created

DateTime

R

Да

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

DataSource

SP.ListDataSource

R

Нет

Получает источник данных, связанный со списком, или null, если список не является виртуальным. Возвращает значение NULL, если значение свойства HasExternalDataSource равно false.

DefaultContentApprovalWorkflowId

GUID

RW

Да

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

DefaultDisplayFormUrl

String

RW

Нет

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

DefaultEditFormUrl

String

RW

Нет

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

DefaultNewFormUrl

String

RW

Нет

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

DefaultView

SP.View

R

Нет

DefaultViewUrl

String

R

Нет

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

Описание

String

RW

Да

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

Direction

String

RW

Да

Получает или задает значение, указывающее порядок чтения списка. Возвращает значение "NONE", "LTR" или "RTL".

DocumentTemplateUrl

String

RW

Да

Получает или задает значение, задающее зависящий от сервера URL-адрес шаблона документа для списка. Возвращает зависящий от сервера URL-адрес, если базовый тип — DocumentLibrary; в противном случае возвращается значение NULL.

DraftVersionVisibility

Int32

RW

Да

Получает или задает значение, указывающее минимальное разрешение для просмотра дополнительных номеров версий и черновиков в списке. Представляет значение SP.DraftVisibilityType: читатель = 0; автор = 1; утверждающий = 2.

EffectiveBasePermissions

SP.BasePermissions

R

Нет

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

EffectiveBasePermissionsForUI

SP.BasePermissions

R

Нет

EnableAttachments

Boolean

RW

Да

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

EnableFolderCreation

Boolean

RW

Да

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

EnableMinorVersions

Boolean

RW

Да

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

EnableModeration

Boolean

RW

Да

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

EnableVersioning

Boolean

RW

Да

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

EntityTypeName

String

R

Да

EventReceivers

SP.EventReceiverDefinitionCollection

R

Нет

Fields

SP.FieldCollection

R

Нет

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

FirstUniqueAncestorSecurableObject

SP.SecurableObject

R

Нет

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

ForceCheckout

Boolean

RW

Да

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

Forms

SP.FormCollection

R

Нет

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

HasExternalDataSource

Boolean

R

Да

Получает значение, указывающее, является ли список внешним.

HasUniqueRoleAssignments

Boolean

R

Нет

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

Hidden

Boolean

RW

Да

Получает или задает логическое значение, указывающее, скрыт ли список. Если значение true, сервер задает для свойства OnQuickLaunch значение false.

Id

GUID

R

Да

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

ImageUrl

String

R

Да

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

InformationRightsManagementSettings

SP.InformationRightsManagementSettings

R

Нет

IrmEnabled

Boolean

RW

Да

IrmExpire

Boolean

RW

Да

IrmReject

Boolean

RW

Да

IsApplicationList

Boolean

RW

Да

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

IsCatalog

Boolean

R

Да

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

IsPrivate

Boolean

R

Да

IsSiteAssetsLibrary

Boolean

R

Нет

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

ItemCount

Int32

R

Да

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

Items

SP.ListItemCollection

R

Нет

Получает все элементы списка.

Операции запросов OData можно использовать для фильтрации элементов (например: …/lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/items?$filter=Status eq 'not started'&$select=Title&$top=5).

LastItemDeletedDate

DateTime

R

Да

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

LastItemModifiedDate

DateTime

RW

Да

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

ListItemEntityTypeFullName

String

R

Да

MultipleDataList

Boolean

RW

Да

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

NoCrawl

Boolean

RW

Да

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

OnQuickLaunch

Boolean

RW

Нет

Получает или задает значение, указывающее, отображается ли список в панели быстрого запуска на сайте. Если значение true, сервер задает для свойства Hidden значение false.

ParentWeb

SP.Web

R

Нет

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

ParentWebUrl

String

R

Да

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

RoleAssignments

SP.RoleAssignmentCollection

R

Нет

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

RootFolder

SP.Folder

R

Нет

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

SchemaXml

String

R

Нет

Получает значение, задающее схему списка.

ServerTemplateCanCreateFolders

Boolean

R

Да

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

TemplateFeatureId

GUID

R

Да

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

Title

String

RW

Да

Получает или задает отображаемый заголовок списка. Длина должна быть <= 255 символов.

UserCustomActions

SP.UserCustomActionCollection

R

Нет

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

ValidationFormula

String

RW

Нет

Получает или задает значение, задающее условия проверки данных элемента списка. Длина должна быть <= 1023 символа.

ValidationMessage

String

RW

Нет

Получает или задает значение, которое указывает сообщение об ошибке, возвращаемое при сбое проверки данных в элементе списка. Длина должна быть <= 1023 символа.

Views

SP.ViewCollection

R

Нет

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

WorkflowAssociations

SP.Workflow.WorkflowAssociationCollection

R

Нет

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

Методы List

AddItem
BreakRoleInheritance
DeleteObject
GetChanges
GetItemById
GetItems
GetListItemChangesSinceToken
GetRelatedFields
GetUserEffectivePermissions
GetView
Recycle
RenderListData
RenderListFormData
ReserveListItemId
ResetRoleInheritance

Метод AddItem

Примеры

Метод BreakRoleInheritance

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

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

/breakroleinheritance(copyroleassignments, clearsubscopes)

Параметры

copyroleassignments

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

clearsubscopes

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

HTTP method

POST

Ответ

Нет

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

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web/lists(guid'a290086b-2d43-4151-add4-893474a930a9')
    /breakroleinheritance(copyroleassignments=false, clearsubscopes=true)
    ?@target='<host web url>'",
  method: "POST",
  success: successHandler,
  error: errorHandler
});

Метод DeleteObject

Примеры

Метод GetChanges

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

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

/getchanges

Параметры

query

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

HTTP method

POST

Ответ

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

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

var metadata = "{ 'query' : { '__metadata': { 'type': 'SP.ChangeQuery' },
    'Add': 'True', 'Item': 'True' }}";

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web/lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')
    /getchanges
    ?@target='<host web url>'",
  method: "POST",
  body: metadata,
  headers: {
    "accept": "application/json; odata=verbose",
    "content-type": "application/json; odata=verbose"
  },
  success: successHandler,
  error: errorHandler
});

Пример ответа

    {"d":
      {"results":[{
        "__metadata":{
          "id":"https://<site url>/_api/SP.ChangeItema7e7c6e9-2c41-47c3-aae9-2b4a63b7a087",
          "uri":"https://<site url>/_api/SP.ChangeItem",
          "type":"SP.ChangeItem"
        },
        "ChangeToken":{"__metadata":{"type":"SP.ChangeToken"}, "StringValue":"1;3;482e418a-0900-414b-8902-02248c2e44e8;634955266749500000;5749111"},
        "ChangeType":1,
        "SiteId":"ce11bfbb-cf9d-4b2b-a642-8673bd48cceb",
        "Time":"2013-02-03T22:17:54Z",
        "ItemId":1,
        "ListId":"482e418a-0900-414b-8902-02248c2e44e8",
        "WebId":"a975b994-fc67-4203-a519-b160175ca967"
      }]
    }}

Метод GetItemById

Возвращает элемент списка с указанным идентификатором.

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

/getitembyid(<идентификатор элемента>)

Параметры

Тип: Int32
Идентификатор элемента списка.

HTTP method

GET

Ответ

Тип: SP.ListItem
Элемент списка с указанным идентификатором.

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

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web/lists(guid'a290086b-2d43-4151-add4-893474a930a9')
    /getitembyid(2)
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Или же можно передать идентификатор элемента списка ресурсу ListItemCollection. Пример: …/web/lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/items(2).

Метод GetItems

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

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

/getitems

Параметры

query

Тип: SP.CamlQuery
Запрос фильтрации. Передайте этот параметр в тексте запроса, как показано в примере запроса.

HTTP method

POST

Ответ

Тип: SP.ListItemCollection
Элементы списка, соответствующие указанному запросу.

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

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web/lists(guid'47f89cf2-359d-4792-9dc4-8da877a5050a')
    /getitems
    ?@target='<host web url>'",
  method: "POST",
  body: "{ 'query' : {'__metadata': { 'type': 'SP.CamlQuery' }, "ViewXml": "<View><Query><Where><Contains><FieldRef Name='Status'/><Value Type='CHOICE'>in progress</Value></Contains></Where></Query></View>" } }",
  headers: {
    "accept": "application/json; odata=verbose",
    "content-type": "application/json; odata=verbose"
  },
  success: successHandler,
  error: errorHandler
});

Метод GetListItemChangesSinceToken

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

/getlistitemchangessincetoken

Параметры

query

Тип: SP.ChangeLogItemQuery
Запрос, содержащий маркер изменения. Передайте этот параметр в тексте запроса, как показано в примере запроса.

HTTP method

POST

Ответ

Тип: GetListItemChangesSinceTokenResult
Stream, содержащей XML-представление изменений элементов списка, которые произошли после указанного изменения.

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

var metadata = "{ 'query': { '__metadata': { 'type': 'SP.ChangeLogItemQuery' },
    'ChangeToken': '1;3;79cc20e6-adda-438e-8a96-792041b33168;635103901830230000;33050019' }}";

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web/lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')
    /getlistitemchangessincetoken
    ?@target='<host web url>'",
  method: "POST",
  body: metadata,
  headers: { "content-type": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Пример указания фильтрованного запроса см. в статье Синхронизация элементов SharePoint с помощью службы REST.

Пример ответа

<?xml version="1.0" encoding="utf-8" ?>
<GetListItemChangesSinceTokenResult>
  <listitems MinTimeBetweenSyncs='0' RecommendedTimeBetweenSyncs='180' MaxBulkDocumentSyncSize='500' MaxRecommendedEmbeddedFileSize='500' EffectivePermMask='FullMask' xmlns:s='uuid:BDC6E3F0-6DA3-11d1-A2A3-00AA00C14882' xmlns:dt='uuid:C2F41010-65B3-11d1-A29F-00AA00C14882' xmlns:rs='urn:schemas-microsoft-com:rowset' xmlns:z='#RowsetSchema'>
    <Changes LastChangeToken="1;3;79cc20e6-adda-438e-8a96-792041b33168;635110802324330000;33811711">
    <List DocTemplateUrl="" DefaultViewUrl="/Lists/TestList/AllItems.aspx" MobileDefaultViewUrl="" ID="{79CC20E6-ADDA-438E-8A96-792041B33168}" Title="TestList" Description="" ImageUrl="/_layouts/15/images/itgen.png?rev=26" Name="{79CC20E6-ADDA-438E-8A96-792041B33168}" BaseType="0" FeatureId="00bfea71-de22-43b2-a848-c05709900100" ServerTemplate="100" Created="20130725 22:22:35" Modified="20130802 22:43:52" LastDeleted="20130725 22:22:35" Version="4" Direction="none" ThumbnailSize="" WebImageWidth="" WebImageHeight="" Flags="545263616" ItemCount="2" AnonymousPermMask="0" RootFolder="/Lists/TestList" ReadSecurity="1" WriteSecurity="1" Author="11" EventSinkAssembly="" EventSinkClass="" EventSinkData="" EmailAlias="" WebFullUrl="/" WebId="a975b994-fc67-4203-a519-b160175ca967" SendToLocation="" ScopeId="ad9949be-be16-4946-b5de-66c912eda54a" MajorVersionLimit="0" MajorWithMinorVersionsLimit="0" WorkFlowId="" HasUniqueScopes="False" NoThrottleListOperations="False" HasRelatedLists="" Followable="False" AllowDeletion="True" AllowMultiResponses="False" EnableAttachments="True" EnableModeration="False" EnableVersioning="False" HasExternalDataSource="False" Hidden="False" MultipleDataList="False" Ordered="False" ShowUser="True" EnablePeopleSelector="False" EnableResourceSelector="False" EnableMinorVersion="False" RequireCheckout="False" ThrottleListOperations="False" ExcludeFromOfflineClient="False" CanOpenFileAsync="True" EnableFolderCreation="False" IrmEnabled="False" IsApplicationList="False" PreserveEmptyValues="False" StrictTypeCoercion="False" EnforceDataValidation="False" MaxItemsPerThrottledOperation="5000">
      <Fields>
        <Field ID="{03e45e84-1992-4d42-9116-26f756012634}" RowOrdinal="0" Type="ContentTypeId" Sealed="TRUE" ReadOnly="TRUE" Hidden="TRUE" DisplayName="Content Type ID" Name="ContentTypeId" DisplaceOnUpgrade="TRUE" SourceID="http://schemas.microsoft.com/sharepoint/v3" StaticName="ContentTypeId" ColName="tp_ContentTypeId" FromBaseType="TRUE"/>
        <Field ID="{fa564e0f-0c70-4ab9-b863-0177e6ddd247}" Type="Text" Name="Title" DisplayName="Title" Required="TRUE" SourceID="http://schemas.microsoft.com/sharepoint/v3" StaticName="Title" FromBaseType="TRUE" ColName="nvarchar1"/>
        <Field ID="{34ad21eb-75bd-4544-8c73-0e08330291fe}" ReadOnly="TRUE" Type="Note" Name="_ModerationComments" DisplayName="Approver Comments" Hidden="TRUE" CanToggleHidden="TRUE" Filterable="FALSE" Sortable="FALSE" SourceID="http://schemas.microsoft.com/sharepoint/v3" StaticName="_ModerationComments" FromBaseType="TRUE" ColName="ntext1"/>
        <Field ID="{39360f11-34cf-4356-9945-25c44e68dade}" ReadOnly="TRUE" Hidden="TRUE" Type="Text" Name="File_x0020_Type" DisplaceOnUpgrade="TRUE" DisplayName="File Type" SourceID="http://schemas.microsoft.com/sharepoint/v3" StaticName="File_x0020_Type" FromBaseType="TRUE" ColName="nvarchar2"/>
        <Field ID="{fc2e188e-ba91-48c9-9dd3-16431afddd50}" Name="WorkAddress" SourceID="http://schemas.microsoft.com/sharepoint/v3" StaticName="WorkAddress" Group="Core Contact and Calendar Columns" DisplayName="Address" Type="Note" NumLines="2" Sortable="FALSE" ColName="ntext2" RowOrdinal="0"/>
        <Field ID="{fce16b4c-fe53-4793-aaab-b4892e736d15}" Name="EMail" SourceID="http://schemas.microsoft.com/sharepoint/v3" StaticName="EMail" Group="Core Contact and Calendar Columns" DisplayName="E-Mail" ReadOnly="FALSE" Type="Text" FromBaseType="TRUE" AllowDeletion="TRUE" ColName="nvarchar3" RowOrdinal="0"/>
        <Field Type="Lookup" DisplayName="anewishlisttitle" Required="FALSE" EnforceUniqueValues="FALSE" List="{482e418a-0900-414b-8902-02248c2e44e8}" ShowField="Title" UnlimitedLengthInDocumentLibrary="FALSE" RelationshipDeleteBehavior="None" ID="{9919f3f8-88fb-43fc-b4cb-658b1db1bfe3}" SourceID="{79cc20e6-adda-438e-8a96-792041b33168}" StaticName="anewishlisttitle" Name="anewishlisttitle" ColName="int1" RowOrdinal="0"/>
        <Field Type="Lookup" DisplayName="Books title" Required="FALSE" EnforceUniqueValues="FALSE" List="{90146606-81fd-410d-9fdd-d03b6349fbcd}" ShowField="Title" UnlimitedLengthInDocumentLibrary="FALSE" RelationshipDeleteBehavior="None" ID="{879a1cba-91b6-4c0a-99fb-29f877aae3ea}" SourceID="{79cc20e6-adda-438e-8a96-792041b33168}" StaticName="Books_x0020_title" Name="Books_x0020_title" ColName="int2" RowOrdinal="0"/>
        <Field ID="{1d22ea11-1e32-424e-89ab-9fedbadb6ce1}" ColName="tp_ID" RowOrdinal="0" ReadOnly="TRUE" Type="Counter" Name="ID" PrimaryKey="TRUE" DisplayName="ID" SourceID="http://schemas.microsoft.com/sharepoint/v3" StaticName="ID" FromBaseType="TRUE"/>
        <Field ID="{c042a256-787d-4a6f-8a8a-cf6ab767f12d}" Type="Computed" DisplayName="Content Type" Name="ContentType" DisplaceOnUpgrade="TRUE" RenderXMLUsingPattern="TRUE" Sortable="FALSE" SourceID="http://schemas.microsoft.com/sharepoint/v3" StaticName="ContentType" Group="_Hidden" PITarget="MicrosoftWindowsSharePointServices" PIAttribute="ContentTypeID" FromBaseType="TRUE">
          <FieldRefs>
            <FieldRef Name="ContentTypeId"/>
          </FieldRefs>
          <DisplayPattern>
            <MapToContentType>
              <Column Name="ContentTypeId"/>
            </MapToContentType>
          </DisplayPattern>
        </Field>
        <…>
      </Fields>
      <RegionalSettings>
        <Language>1033</Language>
        <Locale>1033</Locale>
        <AdvanceHijri>0</AdvanceHijri>
        <CalendarType>1</CalendarType>
        <Time24>False</Time24>
        <TimeZone>480</TimeZone>
        <SortOrder>2070</SortOrder>
        <Presence>True</Presence>
      </RegionalSettings>
      <ServerSettings>
        <ServerVersion>16.0.1810.1236</ServerVersion>
        <RecycleBinEnabled>True</RecycleBinEnabled>
        <ServerRelativeUrl>/</ServerRelativeUrl>
       </ServerSettings>
      </List>
    </Changes>
    <rs:data ItemCount="1">
      <z:row ows_ContentTypeId='0x0100C8CFB1DE383F1B49A44ABD2EB9AC7322' ows_Title='<item title>' ows_ID='2' ows_ContentType='Item' ows_Modified='2013-07-25T23:21:50Z' ows_Created='2013-07-25T23:21:50Z' ows_Author='<author>' ows_Editor='<editor>' ows_owshiddenversion='1' ows_WorkflowVersion='1' ows__UIVersion='512' ows__UIVersionString='1.0' ows_Attachments='0' ows__ModerationStatus='0' ows_LinkTitleNoMenu='<item title>' ows_LinkTitle='<item title>' ows_LinkTitle2='<item title>' ows_SelectTitle='2' ows_Order='200.000000000000' ows_GUID='{D38981C3-2735-4FDF-9B41-91F3ADA8F3F0}' ows_FileRef='2;#Lists/TestList/2_.000' ows_FileDirRef='2;#Lists/TestList' ows_Last_x0020_Modified='2;#2013-07-25T23:21:50Z' ows_Created_x0020_Date='2;#2013-07-25T23:21:50Z' ows_FSObjType='2;#0' ows_SortBehavior='2;#0' ows_PermMask='0x7fffffffffffffff' ows_FileLeafRef='2;#2_.000' ows_UniqueId='2;#{4D719C3B-B8AB-46A0-A080-402DF6EE31C1}' ows_ProgId='2;#' ows_ScopeId='2;#{AD9949BE-BE16-4946-B5DE-66C912EDA54A}' ows__EditMenuTableStart='2_.000' ows__EditMenuTableStart2='2' ows__EditMenuTableEnd='2' ows_LinkFilenameNoMenu='2_.000' ows_LinkFilename='2_.000' ows_LinkFilename2='2_.000' ows_ServerUrl='/Lists/TestList/2_.000' ows_EncodedAbsUrl='https://<site url>.sharepoint.com/Lists/TestList/2_.000' ows_BaseName='2_' ows_MetaInfo='2;#' ows__Level='1' ows__IsCurrentVersion='1' ows_ItemChildCount='2;#0' ows_FolderChildCount='2;#0' ows_ServerRedirected='0' />
    </rs:data>
  </listitems>
</GetListItemChangesSinceTokenResult>

Метод GetRelatedFields

Возвращает коллекцию полей подстановки, использующих данный список как источник данных, у которых FieldLookup.IsRelationship равняется true.

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

/getrelatedfields

Параметры

Нет

HTTP method

GET

Ответ

Тип: SP.RelatedFieldCollection
Коллекция объектов SP.RelatedField с информацией об отношениях между полем в списке и полем подстановки в другом списке.

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

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web/lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')
    /getrelatedfields
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Метод GetUserEffectivePermissions

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

/getusereffectivepermissions(@user)?@user='<имя входа пользователя>'

Параметры

Тип: String
Имя входа пользователя, для которого необходимо получить разрешения. Оно передается как псевдоним в строке запроса, например
SharePoint Online. Или локально с помощью форм: …/getusereffectivepermissions(@v)?@v='i%3A0%23.f%7Cmembership%7Cпользователь%40домен.onmicrosoft.com'
  Локально с помощью утверждений Windows: …/getusereffectivepermissions(@v)?@v='i%3A0%23.w%7Cдомен\пользователь'
  Локально с помощью утверждений SAML: …/getusereffectivepermissions(@v)?@v='i%3A05%3At%7Cadfs+with+roles%7Cпользователь%40домен.com'

HTTP method

GET

Ответ

Тип: SP.BasePermissions
Набор разрешений для заданного пользователя: значения Int64 для частей разрешений высокого и низкого приоритета.

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

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web/lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')
    /getusereffectivepermissions(@user)?@user='i%3A0%23.f%7Cmembership%7Cuser%40domain.onmicrosoft.com'
    &@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Метод GetView

Возвращает представление списка с указанным идентификатором.

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

/getview('<идентификатор представления>')

Параметры

Тип: String
Уникальный идентификатор представления списка.

HTTP method

GET

Ответ

Тип: SP.View
Указанное представление списка.

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

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web/lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')
    /getview('4814949d-3e17-444c-a1a3-cb69bc77e95f')
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Или можно просто указать идентификатор представления в ресурсе ViewCollection. Пример: …/_api/web/lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/views('4814949d-3e17-444c-a1a3-cb69bc77e95f')

Метод Recycle

Перемещает список в корзину и возвращает идентификатор нового элемента корзины.

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

/recycle

Параметры

Нет

HTTP method

POST

Ответ

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

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

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web/lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')
    /recycle
    ?@target='<host web url>'",
  method: "POST",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Метод RenderListData

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

/renderlistdata('<xml представления>')

Параметры

Тип: String
Запрос CAML, определяющий элементы и поля, которые необходимо вернуть.

HTTP method

POST

Ответ

Тип: String
Запрошенные данные списка в представлении, определенным указанным XML.

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

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web/lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')
    /renderlistdata(@viewXml)?@viewXml='<View><RowLimit>10</RowLimit></View>'
    &@target='<host web url>'",
  method: "POST",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Метод RenderListFormData

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

/renderlistformdata(itemid, formid, mode)

Параметры

itemid

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

formid

Тип: String
Идентификатор формы.

mode

Тип: Int32
SP.ControlMode элемента управления, используемого для отображения элемента: 1 = показать; 2 = изменить; 3 = создать.

HTTP method

POST

Ответ

Тип: String
Значения полей и атрибуты схемы полей для элемента списка.

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

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web/lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')
    /renderlistformdata(itemid=4, formid='e8b2f6e3-1081-4b18-833b-475f76473cde', mode=2)
    ?@target='<host web url>'",
  method: "POST",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Метод ReserveListItemId

Резервирует идентификатор элемента списка для идемпотентного создания элемента списка.

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

/reservelistitemid

Параметры

Нет

HTTP method

POST

Ответ

Тип: Int32
Идентификатор резервируемого элемента списка.

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

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web/lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')
    /reservelistitemid
    ?@target='<host web url>'",
  method: "POST",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Метод ResetRoleInheritance

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

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

/resetroleinheritance

Параметры

Нет

HTTP method

POST

Ответ

Нет

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

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'a290086b-2d43-4151-add4-893474a930a9')/items(2)
    /resetroleinheritance
    ?@target='<host web url>'",
  method: "POST",
  success: successHandler,
  error: errorHandler
});

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

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

    {"d":{
      "__metadata":{
        "id":"http://<site url>/_api/Web/Lists(guid'8ade7551-f53c-48c5-9d2b-e89f6528cf47')",
        "uri":"http://<site url>/_api/Web/Lists(guid'8ade7551-f53c-48c5-9d2b-e89f6528cf47')",
        "etag":"\"0\"",
        "type":"SP.List"
      },
      "FirstUniqueAncestorSecurableObject":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'8ade7551-f53c-48c5-9d2b-e89f6528cf47')/FirstUniqueAncestorSecurableObject"}},
      "RoleAssignments":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'8ade7551-f53c-48c5-9d2b-e89f6528cf47')/RoleAssignments"}},
      "ContentTypes":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'8ade7551-f53c-48c5-9d2b-e89f6528cf47')/ContentTypes"}},
      "DefaultView":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'8ade7551-f53c-48c5-9d2b-e89f6528cf47')/DefaultView"}},
      "EventReceivers":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'8ade7551-f53c-48c5-9d2b-e89f6528cf47')/EventReceivers"}},
      "Fields":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'8ade7551-f53c-48c5-9d2b-e89f6528cf47')/Fields"}},
      "Forms":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'8ade7551-f53c-48c5-9d2b-e89f6528cf47')/Forms"}},
      "InformationRightsManagementSettings":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'8ade7551-f53c-48c5-9d2b-e89f6528cf47')/InformationRightsManagementSettings"}},
      "AllowContentTypes":true, 
      "BaseTemplate":100, 
      "BaseType":0, 
      "ContentTypesEnabled":false, 
      "Created":"2013-02-02T21:11:56Z",
      "DefaultContentApprovalWorkflowId":"00000000-0000-0000-0000-000000000000",
      "Description":"",
      "Direction":"none",
      "DocumentTemplateUrl":null, 
      "DraftVersionVisibility":0, 
      "EnableAttachments":true, 
      "EnableFolderCreation":false, 
      "EnableMinorVersions":false, 
      "EnableModeration":false, 
      "EnableVersioning":false,
      "EntityTypeName":"ANewList",
      "ForceCheckout":false, 
      "HasExternalDataSource":false, 
      "Hidden":false, 
      "Id":"8ade7551-f53c-48c5-9d2b-e89f6528cf47",
      "ImageUrl":"/_layouts/15/images/itgen.png?rev=23",
      "IrmEnabled":false, 
      "IrmExpire":false, 
      "IrmReject":false, 
      "IsApplicationList":false, 
      "IsCatalog":false, 
      "IsPrivate":false, 
      "ItemCount":1, 
      "LastItemDeletedDate":"2013-02-02T21:11:56Z",
      "LastItemModifiedDate":"2013-02-03T22:17:55Z",
      "ListItemEntityTypeFullName":"SP.Data.ANewListItem",
      "MultipleDataList":false, 
      "NoCrawl":false, 
      "ParentWebUrl":"/",
      "ServerTemplateCanCreateFolders":true, 
      "TemplateFeatureId":"00bfea71-de22-43b2-a848-c05709900100",
      "Title":"ANewList"
    }}

Ресурс ListCollection

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

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

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

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

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

GET  |  POST

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

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

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web/lists
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

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

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists/getbytitle('Access Requests')
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

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

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Пример запроса POST: создание списка

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web/lists
    ?@target='<host web url>'",
  method: "POST",
  body: "{ '__metadata': { 'type': 'SP.List' }, 'AllowContentTypes': true, 'BaseTemplate': 100,
    'ContentTypesEnabled': true, 'Description': 'My list description', 'Title': 'Test title' }",
  headers: { "content-type": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Методы ListCollection

EnsureSiteAssetsLibrary
EnsureSitePagesLibrary
GetById
GetByTitle

Метод EnsureSiteAssetsLibrary

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

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

/ensuresiteassetslibrary

Параметры

Нет

HTTP method

POST

Ответ

Тип: SP.List
Список, являющийся расположением по умолчанию для активов вики-страницы.

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

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web/lists
    /ensuresiteassetslibrary
    ?@target='<host web url>'",
  method: "POST",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Метод EnsureSitePagesLibrary

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

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

/ensuresitepageslibrary

Параметры

Нет

HTTP method

POST

Ответ

Тип: SP.List
Список, являющийся расположением по умолчанию для вики-страниц.

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

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web/lists
    /ensuresitepageslibrary
    ?@target='<host web url>'",
  method: "POST",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Метод GetById

Возвращает список с указанным идентификатором.

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

/getbyid

Параметры

Тип: String
Идентификатор списка.

HTTP method

GET

Ответ

Тип: SP.ListItem
Список с указанным идентификатором.

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

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web/lists
    /getbyid('51925dd7-2108-481a-b1ef-4bfa4e69d48b')
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Или же можно передать идентификатор списка ресурсу ListCollection. Пример: …/web/lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b').

Метод GetByTitle

Возвращает список с указанным названием из коллекции.

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

/getbytitle

Параметры

Тип: String
Заголовок списка.

HTTP method

GET

Ответ

Тип: SP.ListItem
Список с указанным заголовком.

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

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web/lists
    /getbytitle('Access Requests')
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

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

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

    {"d":{
      "results":[{
        "__metadata":{"id":"https://<site url>/_api/Web/Lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')",
        "uri":"https://<site url>/_api/Web/Lists(guid'51925dd7-2108-481a-b1ef-
    4bfa4e69d48b')",
        "etag":"\"6\"",
        "type":"SP.List"
      },
      "FirstUniqueAncestorSecurableObject":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/FirstUniqueAncestorSecurableObject"}},
      "RoleAssignments":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/RoleAssignments"}},
      "ContentTypes":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/ContentTypes"}},
      "DefaultView":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/DefaultView"}},
      "EventReceivers":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/EventReceivers"}},
      "Fields":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/Fields"}},
      "Forms":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/Forms"}},
      "InformationRightsManagementSettings":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/InformationRightsManagementSettings"}},
      "Items":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/Items"}},
      "ParentWeb":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/ParentWeb"}},
      "RootFolder":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/RootFolder"}},
      "UserCustomActions":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/UserCustomActions"}},
      "Views":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/Views"}},
      "WorkflowAssociations":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/WorkflowAssociations"}},
      "AllowContentTypes":true,
      "BaseTemplate":160,"BaseType":0,
      "ContentTypesEnabled":true,
      "Created":"2013-06-10T17:14:49Z",
      "DefaultContentApprovalWorkflowId":"00000000-0000-0000-0000-000000000000",
      "Description":"Use this list to track access requests to a site or uniquely permissioned items in the site.",
      "Direction":"none",
      "DocumentTemplateUrl":null,
      "DraftVersionVisibility":0,
      "EnableAttachments":false,
      "EnableFolderCreation":false,
      "EnableMinorVersions":false,
      "EnableModeration":false,
      "EnableVersioning":true,
      "EntityTypeName":"Access_x0020_Requests",
      "ForceCheckout":false,
      "HasExternalDataSource":false,
      "Hidden":true,
      "Id":"51925dd7-2108-481a-b1ef-4bfa4e69d48b",
      "ImageUrl":"/_layouts/15/images/itgen.gif?rev=26",
      "IrmEnabled":false,
      "IrmExpire":false,
      "IrmReject":false,
      "IsApplicationList":false,
      "IsCatalog":false,
      "IsPrivate":false,
      "ItemCount":3,
      "LastItemDeletedDate":"2013-06-10T17:14:49Z",
      "LastItemModifiedDate":"2013-06-10T17:20:48Z",
      "ListItemEntityTypeFullName":"SP.Data.Access_x0020_RequestsItem",
      "MultipleDataList":false,
      "NoCrawl":true,
      "ParentWebUrl":"/",
      "ServerTemplateCanCreateFolders":true,
      "TemplateFeatureId":"a0f12ee4-9b60-4ba4-81f6-75724f4ca973",
      "Title":"Access Requests"},
      {
        "__metadata":{
          "id":"https://<site url>/_api/Web/Lists(guid'482e418a-0900-414b-8902-02248c2e44e8')",
          "uri":"https://<site url>/_api/Web/Lists(guid'482e418a-0900-414b-8902-
    02248c2e44e8')",
          "etag":"\"1\"",
          "type":"SP.List"
        },
        "FirstUniqueAncestorSecurableObject":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'482e418a-0900-414b-8902- 
    02248c2e44e8')/FirstUniqueAncestorSecurableObject"}},
        "RoleAssignments":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'482e418a-0900-414b-8902-02248c2e44e8')/RoleAssignments"}},
        "ContentTypes":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'482e418a-0900-414b-8902-02248c2e44e8')/ContentTypes"}},
        "DefaultView":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'482e418a-0900-414b-8902-02248c2e44e8')/DefaultView"}},
        "EventReceivers":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'482e418a-0900-414b-8902-02248c2e44e8')/EventReceivers"}},
        "Fields":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'482e418a-0900-414b-8902-02248c2e44e8')/Fields"}},
        "Forms":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'482e418a-0900-414b-8902-02248c2e44e8')/Forms"}},
        "InformationRightsManagementSettings":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'482e418a-0900-414b-8902-02248c2e44e8')/InformationRightsManagementSettings"}},
        "Items":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'482e418a-0900-414b-8902-02248c2e44e8')/Items"}},
        "ParentWeb":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'482e418a-0900-414b-8902-02248c2e44e8')/ParentWeb"}},
        "RootFolder":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'482e418a-0900-414b-8902-02248c2e44e8')/RootFolder"}},
        "UserCustomActions":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'482e418a-0900-414b-8902-02248c2e44e8')/UserCustomActions"}},
        "Views":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'482e418a-0900-414b-8902-02248c2e44e8')/Views"}},
        "WorkflowAssociations":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'482e418a-0900-414b-8902-02248c2e44e8')/WorkflowAssociations"}},
        "AllowContentTypes":true,
        "BaseTemplate":100,
        "BaseType":0,
        "ContentTypesEnabled":false,
        "Created":"2013-02-02T21:11:56Z",
        "DefaultContentApprovalWorkflowId":"00000000-0000-0000-0000-000000000000",
        "Description":"",
        "Direction":"none",
        "DocumentTemplateUrl":null,
        "DraftVersionVisibility":0,
        "EnableAttachments":true,
        "EnableFolderCreation":false,
        "EnableMinorVersions":false,
        "EnableModeration":false,
        "EnableVersioning":false,
        "EntityTypeName":"AList",
        "ForceCheckout":false,
        "HasExternalDataSource":false,
        "Hidden":false,
        "Id":"482e418a-0900-414b-8902-02248c2e44e8",
        "ImageUrl":"/_layouts/15/images/itgen.png?rev=23",
        "IrmEnabled":false,
        "IrmExpire":false,
        "IrmReject":false,
        "IsApplicationList":false,
        "IsCatalog":false,
        "IsPrivate":false,
        "ItemCount":3,
        "LastItemDeletedDate":"2013-02-02T21:11:56Z",
        "LastItemModifiedDate":"2013-06-26T22:31:03Z",
        "ListItemEntityTypeFullName":"SP.Data.AListListItem",
        "MultipleDataList":false,
        "NoCrawl":false,
        "ParentWebUrl":"/",
        "ServerTemplateCanCreateFolders":true,
        "TemplateFeatureId":"00bfea71-de22-43b2-a848-c05709900100",
        "Title":"AList"
      }]
    }}

Ресурс ListItem

Представляет элемент или строку списка. Тип элемента списка — SP.SecurableObject.

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

Примечание

Параметр запроса OData $skip не работает с данной конечной точкой.

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

http://<URL-адрес сайта>/web/lists(guid'<идентификатор списка>')/items(<идентификатор элемента>)
http://<URL-адрес сайта>/web/lists/getbytitle('<заголовок списка>')/items(<идентификатор элемента>)

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

GET  |  POST  |  DELETE  |  MERGE

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

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

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'a290086b-2d43-4151-add4-893474a930a9')/items(2)
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Пример запроса POST: создание элемента списка

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'a290086b-2d43-4151-add4-893474a930a9')/items
    ?@target='<host web url>'",
  method: "POST",
  body: "{ '__metadata': { 'type': 'SP.Data.Team_x0020_tasksListItem' },
    'Title': 'Teams incorporate feedback', 'AssignedToId': {"results":[1]},
    'StartDate':'2014-01-29T08:00:00Z', 'DueDate':'2014-01-31T08:00:00Z',
    'PredecessorsId': {"results":[4]}}",
  headers: { 
    "accept": "application/json;odata=verbose",
    "content-type": "application/json;odata=verbose"
  },
  success: successHandler,
  error: errorHandler
});

Примечание

Чтобы создать или изменить элемент списка, необходимо знать свойство ListItemEntityTypeFullName списка и передать его как значение type в тексте запроса HTTP.

Примеры

Пример запроса MERGE: изменение элемента списка

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'a290086b-2d43-4151-add4-893474a930a9')/items(2)
    ?@target='<host web url>'",
  method: "POST",
  body: "{ '__metadata': { 'type': 'SP.Data.Team_x0020_tasksListItem' },
    'Priority': '(1) High', 'Status': 'In Progress', 'PercentComplete': 0.3 }",
  headers: { 
    "IF-MATCH": "*",
    "content-type": "application/json;odata=verbose",
    "X-HTTP-Method": "MERGE"
  },
  success: successHandler,
  error: errorHandler
});

Примечание

Чтобы создать или изменить элемент списка, необходимо знать свойство ListItemEntityTypeFullName списка и передать его как значение type в тексте запроса HTTP.

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

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'a290086b-2d43-4151-add4-893474a930a9')/items(2)
    ?@target='<host web url>'",
  method: "POST",
  headers: { 
    "IF-MATCH”: "*",
    "X-HTTP-Method": "DELETE"
  },
  success: successHandler,
  error: errorHandler
});

Чтобы получить GUID операции удаления, используйте метод Recycle элемента.

Свойства ListItem

Свойство

Тип

R/W

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

Описание

AttachmentFiles

SP.AttachmentCollection

R

Нет

Указывает коллекцию вложений, связанных с элементом списка.

ContentType

SP.ContentType

R

Нет

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

DisplayName

String

R

Да (отображается как значение "Title")

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

EffectiveBasePermissions

SP.BasePermissions

R

Да

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

EffectiveBasePermissionsForUI

SP.BasePermissions

R

Да

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

FieldValuesAsHtml

SP.FieldStringValues

R

Нет

Получает значения элемента списка в формате HTML.

FieldValuesAsText

SP.FieldStringValues

R

Нет

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

FieldValuesForEdit

SP.FieldStringValues

R

Нет

Получает форматированные значения, отображаемые в форме редактирования.

File

SP.File

R

Нет

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

FileSystemObjectType

Int32

R

Да

Получает значение, указывающее, является ли элемент списка файлом или папкой списка. Представляет значение SP.FileSystemObjectType: недопустимо = -1; файл = 0; папка = 1; веб-сайт = 2.

FirstUniqueAncestorSecurableObject

SP.SecurableObject

R

Нет

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

Folder

SP.Folder

R

Нет

Получает объект папки, связанный с элементом папки.

HasUniqueRoleAssignments

Boolean

R

Нет

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

Id

Int32

R

Да

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

ParentList

SP.List

R

Нет

Получает родительский список, содержащий элемент списка.

RoleAssignments

SP.RoleAssignmentCollection

R

Нет

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

Методы ListItem

BreakRoleInheritance
DeleteObject
GetUserEffectivePermissions
Recycle
ResetRoleInheritance
ValidateUpdateListItem

Метод BreakRoleInheritance

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

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

/breakroleinheritance(copyroleassignments, clearsubscopes)

Параметры

copyroleassignments

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

clearsubscopes

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

HTTP method

POST

Ответ

Нет

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

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'a290086b-2d43-4151-add4-893474a930a9')/items(2)
    /breakroleinheritance(copyroleassignments=true, clearsubscopes=false)
    ?@target='<host web url>'",
  method: "POST",
  success: successHandler,par
  error: errorHandler
});

Метод DeleteObject

Примеры

Метод GetUserEffectivePermissions

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

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

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

Параметры

Тип: String
Имя входа пользователя, для которого необходимо получить разрешения. Например:
SharePoint Online: …/getusereffectivepermissions(@v)?@v='i%3A0%23.f%7Cmembership%7C<пользователь>%40<домен>.onmicrosoft.com'
  Локально с помощью утверждений: …/getusereffectivepermissions(@v)?@v='i%3A0%23.w%7C<домен\пользователь>'
  Локально с помощью форм: …/getusereffectivepermissions(@v)?@v='<домен\пользователь>'

HTTP method

GET

Ответ

Тип: SP.BasePermissions
Базовые разрешения для элемента списка заданного пользователя: значения Int64 для частей разрешений высокого и низкого приоритета.

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

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'a290086b-2d43-4151-add4-893474a930a9')/items(2)
    /getusereffectivepermissions(@v)?@v='i%3A0%23.f%7Cmembership%7Cuser%40domain.onmicrosoft.com'
    &@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Метод Recycle

Перемещает элемент списка в корзину и возвращает идентификатор нового элемента корзины.

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

/recycle

Параметры

Нет

HTTP method

POST

Ответ

Тип: GUID
Идентификатор GUID удаленного элемента списка.

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

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'a290086b-2d43-4151-add4-893474a930a9')/items(2)
    /recycle
    ?@target='<host web url>'",
  method: "POST",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Метод ResetRoleInheritance

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

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

/resetroleinheritance

Параметры

Нет

HTTP method

POST

Ответ

Нет

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

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'a290086b-2d43-4151-add4-893474a930a9')/items(2)
    /resetroleinheritance
    ?@target='<host web url>'",
  method: "POST",
  success: successHandler,
  error: errorHandler
});

Метод ValidateUpdateListItem

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

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

/validateupdatelistitem

Параметры

formValues

Тип: SP.ListItemFormUpdateValue[]
Изменяемые поля и новые значения. Передайте этот параметр в тексте запроса, как показано в примере запроса.

bNewDocumentUpdate

Тип Boolean
Значение true, если элемент списка является документом, который был обновлен после отправки, в противном случае — значение otherwise false. Передайте этот параметр в теле запроса, как это показано в примере, или в URI.

HTTP method

POST

Ответ

Тип: SP.ListItemFormUpdateValue[]
Массив объектов, представляющий измененные поля и значения.

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

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'a290086b-2d43-4151-add4-893474a930a9')/items(2)
    /validateupdatelistitem
    ?@target='<host web url>'",
  method: "POST",
  body: "{ 'formValues':[{'FieldName':'Status', 'FieldValue':'Deferred'},
    {'FieldName':'StartDate', 'FieldValue':'12/31/2014'}], 'bNewDocumentUpdate': false }",
  headers: {
    "accept": "application/json; odata=verbose",
    "content-type": "application/json;odata=verbose"
  },
  success: successHandler,
  error: errorHandler
});

Пример ответа

    {"d":{
      "ValidateUpdateListItem":{"results":[
        {
          "__metadata":{"type":"SP.ListItemFormUpdateValue"},
          "ErrorMessage":null,
          "FieldName":"Status",
          "FieldValue":"Deferred",
          "HasException":false
        },{
          "__metadata":{"type":"SP.ListItemFormUpdateValue"},
          "ErrorMessage":null,
          "FieldName":"StartDate",
          "FieldValue":"12/31/2014",
          "HasException":false
        }
      ]}
    }}

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

В следующем примере ресурс ListItem представлен в формате JSON. Ресурс также возвращает значения полей.

    {"d":{
      "__metadata":{,
        "id":"2bbdaee6-1172-4e36-9f90-ce35ec9b6207",
        "uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)",
        "etag":"\"1\"",
        "type":"SP.Data.Team_x0020_tasksListItem"
      },
      "FirstUniqueAncestorSecurableObject":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/FirstUniqueAncestorSecurableObject"}},
      "RoleAssignments":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/RoleAssignments"}},
      "AttachmentFiles":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/AttachmentFiles"}},
      "ContentType":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/ContentType"}},
      "FieldValuesAsHtml":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/FieldValuesAsHtml"}},
      "FieldValuesAsText":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/FieldValuesAsText"}},
      "FieldValuesForEdit":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/FieldValuesForEdit"}},
      "File":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/File"}},
      "Folder":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/Folder"}},
      "ParentList":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/ParentList"}},
      "FileSystemObjectType":0,
      "Id":2,
      "ID":2,
      "ContentTypeId":"0x0108004F8963A897E4E64A83E990C1B6B65770",
      "Title":"Assign teams",
      "Modified":"2013-09-03T17:50:30Z",
      "Created":"2013-09-03T17:50:30Z",
      "AuthorId":1073741823,
      "EditorId":1073741823,
      "OData__UIVersionString":"1.0",
      "Attachments":false,
      "GUID":"ce6e516e-2da4-4a3e-9325-daf7d7f61490",
      "PredecessorsId":{"results":[1]},
      "Priority":"(2) Normal",
      "Status":"Not Started",
      "PercentComplete":0,
      "AssignedToId":{"results":[1]},
      "Body":null,
      "StartDate":"2014-01-02T08:00:00Z",
      "DueDate":"2014-01-02T08:00:00Z",
      "Checkmark":"0",
      "RelatedItems":null
    }}

Ресурс ListItemCollection

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

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

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

http://<URL-адрес сайта>/web/lists(guid'<идентификатор списка>')/items
http://<URL-адрес сайта>/web/lists/getbytitle('<заголовок списка>')/items

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

GET  |  POST

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

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

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'a290086b-2d43-4151-add4-893474a930a9')/items
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

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

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'a290086b-2d43-4151-add4-893474a930a9')/items(2)
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Операции запросов OData можно использовать для фильтрации определенных элементов (например: …/lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/items?$filter=Status eq 'not started'&$select=Title&$top=5).

Пример запроса POST: создание элемента списка

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'a290086b-2d43-4151-add4-893474a930a9')/items
    ?@target='<host web url>'",
  method: "POST",
  body: "{ '__metadata': { 'type': 'SP.Data.Team_x0020_tasksListItem' },
    'Title': 'Teams incorporate feedback', 'AssignedToId': {"results":[1]},
    'StartDate':'2014-01-29T08:00:00Z', 'DueDate':'2014-01-31T08:00:00Z',
    'PredecessorsId': {"results":[4]} }",
  headers: { 
    "accept": "application/json;odata=verbose",
    "content-type": "application/json;odata=verbose"
  },
  success: successHandler,
  error: errorHandler
});

Примечание

Чтобы создать или изменить элемент списка, необходимо знать свойство ListItemEntityTypeFullName списка и передать его как значение type в тексте запроса HTTP.

Примеры

Методы ListItemCollection

GetById

Метод GetById

Возвращает элемент списка с указанным идентификатором.

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

/getbyid(<идентификатор элемента>)

Параметры

Тип: Int32
Идентификатор элемента списка.

HTTP method

GET

Ответ

Тип: SP.ListItem
Элемент списка с указанным идентификатором.

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

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'a290086b-2d43-4151-add4-893474a930a9')/items
    /getbyid(2)
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Или же можно указать идентификатор списка в ресурсе ListItemCollection. Пример: …/_api/web/lists(guid'a290086b-2d43-4151-add4-893474a930a9')/items(2).

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

В следующем примере ресурс ListItemCollection представлен в формате JSON, который возвращает коллекцию ресурсов ListItem.

    {"d":{
      "results":[{
        "__metadata":{
          "id":"dd9ab60c-4653-4654-85de-1d090f0d416f",
          "uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(1)",
          "etag":"\"1\"",
          "type":"SP.Data.Team_x0020_tasksListItem"
        },
        "FirstUniqueAncestorSecurableObject":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(1)/FirstUniqueAncestorSecurableObject"}},
        "RoleAssignments":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(1)/RoleAssignments"}},
        "AttachmentFiles":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(1)/AttachmentFiles"}},
        "ContentType":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(1)/ContentType"}},
        "FieldValuesAsHtml":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(1)/FieldValuesAsHtml"}},
        "FieldValuesAsText":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(1)/FieldValuesAsText"}},
        "FieldValuesForEdit":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(1)/FieldValuesForEdit"}},
        "File":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(1)/File"}},
        "Folder":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(1)/Folder"}},
        "ParentList":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(1)/ParentList"}},
        "FileSystemObjectType":0,
        "Id":1,
        "ID":1,
        "ContentTypeId":"0x0108004F8963A897E4E64A83E990C1B6B65770",
        "Title":"Triage requests",
        "Modified":"2013-09-03T17:49:26Z",
        "Created":"2013-09-03T17:49:26Z",
        "AuthorId":1073741823,
        "EditorId":1073741823,
        "OData__UIVersionString":"1.0",
        "Attachments":false,
        "GUID":"e132ef1b-698e-4d21-ba1b-29fa5c38fe8e",
        "PredecessorsId":{"results":[]},
        "Priority":"(2) Normal",
        "Status":"Not Started",
        "PercentComplete":0,
        "AssignedToId":{"results":[1,21]},
        "Body":null,
        "StartDate":"2014-01-01T08:00:00Z",
        "DueDate":"2014-01-02T08:00:00Z",
        "Checkmark":"0",
        "RelatedItems":null
        },{
        "__metadata":{
          "id":"687e63a4-ed44-4bf2-881f-c83e5d3fd020",
          "uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)",
          "etag":"\"5\"",
          "type":"SP.Data.Team_x0020_tasksListItem"
        },
        "FirstUniqueAncestorSecurableObject":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/FirstUniqueAncestorSecurableObject"}},
        "RoleAssignments":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/RoleAssignments"}},
        "AttachmentFiles":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/AttachmentFiles"}},
        "ContentType":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/ContentType"}},
        "FieldValuesAsHtml":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/FieldValuesAsHtml"}},
        "FieldValuesAsText":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/FieldValuesAsText"}},
        "FieldValuesForEdit":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/FieldValuesForEdit"}},
        "File":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/File"}},
        "Folder":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/Folder"}},
        "ParentList":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/ParentList"}},
        "FileSystemObjectType":0,
        "Id":2,
        "ID":2,
        "ContentTypeId":"0x0108004F8963A897E4E64A83E990C1B6B65770",
        "Title":"Assign teams",
        "Modified":"2013-09-03T19:24:51Z",
        "Created":"2013-09-03T17:50:30Z",
        "AuthorId":1073741823,
        "EditorId":1073741823,
        "OData__UIVersionString":"1.0",
        "Attachments":false,
        "GUID":"ce6e516e-2da4-4a3e-9325-daf7d7f61490",
        "PredecessorsId":{"results":[1]},
        "Priority":"(1) High",
        "Status":"In Progress",
        "PercentComplete":0.3,
        "AssignedToId":{"results":[1]},
        "Body":null,
        "StartDate":"2014-01-02T08:00:00Z",
        "DueDate":"2014-01-02T08:00:00Z",
        "Checkmark":"0",
        "RelatedItems":null
        },{
        …
      }]
    }}

Ресурс View

Задает представление списка.

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

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

http://<URL-адрес сайта>/_api/web/lists(guid'<идентификатор списка>')/views('<идентификатор представления>')

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

GET  |  POST  |  DELETE  |  MERGE  |  PUT

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

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

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /views('0dc42244-4bae-4da9-b074-8b8e9d8e50bc')
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Или же можно использовать метод GetByTitle ресурса ViewCollection, чтобы получить представление по его заголовку (он чувствителен к регистру). Пример: …/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/views/getbytitle('By Status').

Пример запроса MERGE: изменение представления

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /views('0dc42244-4bae-4da9-b074-8b8e9d8e50bc')
    ?@target='<host web url>'",
  method: "POST",
  body: "{ '__metadata': { 'type': 'SP.View' }, 'Title': 'New Mobile Default View',
    'MobileDefaultView': true, 'RowLimit': 5 }",
  headers: { 
    "content-type": "application/json;odata=verbose",
    "X-HTTP-Method": "MERGE"
  },
  success: successHandler,
  error: errorHandler
});

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

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /views('0dc42244-4bae-4da9-b074-8b8e9d8e50bc')
    ?@target='<host web url>'",
  method: "POST",
  headers: { "X-HTTP-Method": "DELETE" },
  success: successHandler,
  error: errorHandler
});

Примеры

Свойства View

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

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /views('0dc42244-4bae-4da9-b074-8b8e9d8e50bc')/<property name>
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Свойство

Тип

R/W

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

Описание

Aggregations

String

RW

Да

Получает или задает значение, которое указывает поля и функции, определяющие общие показатели в представлении списка. Если свойство имеет ненулевое значение, XML-код должен соответствовать типу FieldRefDefinitionAggregation, как указано в [MS-WSSCAML].

AggregationsStatus

String

RW

Да

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

BaseViewId

String

R

Да

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

ContentTypeId

SP.ContentTypeId

RW

Да

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

DefaultView

Boolean

RW

Да

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

DefaultViewForContentType

Boolean

RW

Да

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

EditorModified

Boolean

RW

Да

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

Formats

String

RW

Да

Получает или задает значение, задающее форматирование столбцов и строк списка. Если свойство имеет ненулевое значение, XML-код должен соответствовать типу ViewFormatDefinitions, как указано в [MS-WSSCAML].

Hidden

Boolean

RW

Да

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

HtmlSchemaXml

String

R

Да

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

Id

GUID

R

Да

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

ImageUrl

String

R

Да

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

IncludeRootFolder

Boolean

RW

Да

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

JsLink

String

RW

Да

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

ListViewXml

String

RW

Да

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

Метод

String

RW

Да

Получает или задает значение, указывающее метод просмотра для представления списка. Если свойство имеет ненулевое значение, XML-код должен соответствовать типу Method, как указано в [MS-WSSCAP].

MobileDefaultView

Boolean

RW

Да

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

MobileView

Boolean

RW

Да

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

ModerationType

String

R

Да

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

OrderedView

Boolean

R

Да

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

Paged

Boolean

RW

Да

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

PersonalView

Boolean

R

Да

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

ReadOnlyView

Boolean

R

Да

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

RequiresClientIntegration

Boolean

R

Да

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

RowLimit

Int32

RW

Да

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

Scope

Int32

RW

Да

Получает или задает значение, указывающее область для представления списка. Представляет значение ViewScope. DefaultValue = 0, Recursive = 1, RecursiveAll = 2, FilesOnly = 3.

ServerRelativeUrl

String

R

Да

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

StyleId

String

R

Да

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

Threaded

Boolean

R

Да

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

Title

String

RW

Да

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

Toolbar

String

RW

Да

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

ToolbarTemplateName

String

R

Да

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

ViewData

String

RW

Да

Получает или задает значение, указывающее данные для представления списка. Если свойство имеет ненулевое значение, XML-код должен соответствовать типу FieldRefDefinitionViewData, как указано в [MS-WSSCAML].

ViewFields

SP.ViewFieldCollection

R

Нет

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

ViewJoins

String

RW

Да

Получает или задает значение, которое указывает соединения, используемые для представления списка. Если свойство имеет ненулевое значение, XML-код должен соответствовать типу ListJoinsDefinition, как указано в [MS-WSSCAML].

ViewProjectedFields

String

RW

Да

Получает или задает значение, указывающее предполагаемые поля, которые будут использоваться в представлении списка. Если свойство имеет ненулевое значение, XML-код должен соответствовать типу ProjectedFieldsDefinitionType, как указано в [MS-WSSCAML].

ViewQuery

String

RW

Да

Получает или задает значение, которое указывает запрос, используемый представлением списка. Если свойство имеет ненулевое значение, XML-код должен соответствовать типу CamlQueryRoot, как указано в [MS-WSSCAML].

ViewType

String

R

Да

Получает значение, задающее тип списка. HTML, GRID, CALENDAR, RECURRENCE, CHART или GANTT.

Методы представления

DeleteObject
RenderAsHtml

Метод DeleteObject

Примеры

Метод RenderAsHtml

Возвращает представление списка в формате HTML.

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

/renderashtml

Параметры

Нет

HTTP method

GET

Ответ

Тип: String
Представление списка отображается в формате HTML.

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

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /views('0dc42244-4bae-4da9-b074-8b8e9d8e50bc')
    /renderashtml
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

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

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

    {"d":{
      "__metadata":{,
        "id":"https://<site url>/_api/Web/Lists(guid'da58632f-faf0-4a78-8219-99c307747741')/Views(guid'0dc42244-4bae-4da9-b074-8b8e9d8e50bc')",
        "uri":"https://<site url>/_api/Web/Lists(guid'da58632f-faf0-4a78-8219-99c307747741')/Views(guid'0dc42244-4bae-4da9-b074-8b8e9d8e50bc')",
        "type":"SP.View"
      },
      "ViewFields":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'da58632f-faf0-4a78-8219-99c307747741')/Views(guid'0dc42244-4bae-4da9-b074-8b8e9d8e50bc')/ViewFields"}},
      "Aggregations":null,
      "AggregationsStatus":null,
      "BaseViewId":"2",
      "ContentTypeId":{"__metadata":{"type":"SP.ContentTypeId"}, "StringValue":"0x"},
      "DefaultView":false,
      "DefaultViewForContentType":false,
      "EditorModified":false,
      "Formats":null,
      "Hidden":false,
      "HtmlSchemaXml":"<View Name=\"{0DC42244-4BAE-4DA9-B074-8B8E9D8E50BC}\" MobileView=\"TRUE\" Type=\"HTML\" DisplayName=\"Late Tasks\" Url=\"/Lists/Backlog items/late.aspx\" Level=\"1\" BaseViewID=\"2\" ContentTypeID=\"0x\" ImageUrl=\"/_layouts/15/images/issuelst.png?rev=31\"><JSLink>hierarchytaskslist.js</JSLink><XslLink Default=\"TRUE\">main.xsl</XslLink><RowLimit Paged=\"TRUE\">100</RowLimit><Toolbar Type=\"Standard\" /><ViewFields><FieldRef Name=\"Checkmark\" /><FieldRef Name=\"LinkTitle\" /><FieldRef Name=\"DueDate\" /><FieldRef Name=\"AssignedTo\" /></ViewFields><ViewData><FieldRef Name=\"PercentComplete\" Type=\"StrikeThroughPercentComplete\" /><FieldRef Name=\"DueDate\" Type=\"TimelineDueDate\" /></ViewData><Query><Where><And><Or><IsNull><FieldRef Name=\"PercentComplete\" /></IsNull><Neq><FieldRef Name=\"PercentComplete\" /><Value Type=\"Number\">1</Value></Neq></Or><Lt><FieldRef Name=\"DueDate\" /><Value Type=\"DateTime\"><Today /></Value></Lt></And></Where><OrderBy><FieldRef Name=\"DueDate\" /><FieldRef Name=\"Priority\" /></OrderBy></Query></View>",
      "Id":"0dc42244-4bae-4da9-b074-8b8e9d8e50bc",
      "ImageUrl":"/_layouts/15/images/issuelst.png?rev=31",
      "IncludeRootFolder":false,
      "ViewJoins":null,
      "JSLink":"hierarchytaskslist.js",
      "ListViewXml":"<View Name=\"{0DC42244-4BAE-4DA9-B074-8B8E9D8E50BC}\" MobileView=\"TRUE\" Type=\"HTML\" DisplayName=\"Late Tasks\" Url=\"/Lists/Backlog items/late.aspx\" Level=\"1\" BaseViewID=\"2\" ContentTypeID=\"0x\" ImageUrl=\"/_layouts/15/images/issuelst.png?rev=31\" ><Query><Where><And><Or><IsNull><FieldRef Name=\"PercentComplete\" /></IsNull><Neq><FieldRef Name=\"PercentComplete\" /><Value Type=\"Number\">1</Value></Neq></Or><Lt><FieldRef Name=\"DueDate\" /><Value Type=\"DateTime\"><Today /></Value></Lt></And></Where><OrderBy><FieldRef Name=\"DueDate\" /><FieldRef Name=\"Priority\" /></OrderBy></Query><ViewFields><FieldRef Name=\"Checkmark\" /><FieldRef Name=\"LinkTitle\" /><FieldRef Name=\"DueDate\" /><FieldRef Name=\"AssignedTo\" /></ViewFields><RowLimit Paged=\"TRUE\">100</RowLimit><JSLink>hierarchytaskslist.js</JSLink><XslLink Default=\"TRUE\">main.xsl</XslLink><Toolbar Type=\"Standard\"/></View>",
      "Method":null,
      "MobileDefaultView":false,
      "MobileView":true,
      "ModerationType":null,
      "OrderedView":false,
      "Paged":true,
      "PersonalView":false,
      "ViewProjectedFields":null,
      "ViewQuery":"<Where><And><Or><IsNull><FieldRef Name=\"PercentComplete\" /></IsNull><Neq><FieldRef Name=\"PercentComplete\" /><Value Type=\"Number\">1</Value></Neq></Or><Lt><FieldRef Name=\"DueDate\" /><Value Type=\"DateTime\"><Today /></Value></Lt></And></Where><OrderBy><FieldRef Name=\"DueDate\" /><FieldRef Name=\"Priority\" /></OrderBy>",
      "ReadOnlyView":false,
      "RequiresClientIntegration":false,
      "RowLimit":100,
      "Scope":0,
      "ServerRelativeUrl":"/Lists/Backlog items/late.aspx",
      "StyleId":null,
      "Threaded":false,
      "Title":"Late Tasks",
      "Toolbar":"",
      "ToolbarTemplateName":null,
      "ViewType":"HTML",
      "ViewData":"<FieldRef Name=\"PercentComplete\" Type=\"StrikeThroughPercentComplete\" /><FieldRef Name=\"DueDate\" Type=\"TimelineDueDate\" />"
    }}

Ресурс ViewCollection

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

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

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

http://<адрес сайта>/_api/web/lists(guid'<идентификатор списка>')/views

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

GET  |  POST

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

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

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'da58632f-faf0-4a78-8219-99c307747741')/views
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

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

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /views('0dc42244-4bae-4da9-b074-8b8e9d8e50bc')
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Или же можно использовать метод GetByTitle ресурса ViewCollection, чтобы получить представление по его заголовку (он чувствителен к регистру). Пример: …/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/views/getbytitle('By Status').

Пример запроса POST: создание представления

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'da58632f-faf0-4a78-8219-99c307747741')/views
    ?@target='<host web url>'",
  method: "POST",
  body: "{ '__metadata': { 'type': 'SP.View' }, 'Title': 'By Status',
    'PersonalView': false }",
  headers: { 
    "accept": "application/json;odata=verbose",
    "content-type": "application/json;odata=verbose"
  },
  success: successHandler,
  error: errorHandler
});

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

Методы ViewCollection

GetById
GetByTitle

Метод GetById

Получает представление списка с указанным идентификатором.

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

/getbyid('<идентификатор представления>')

Параметры

Тип: String
Идентификатор представления.

HTTP method

GET

Ответ

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

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

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'da58632f-faf0-4a78-8219-99c307747741')/views
    /getbyid('0dc42244-4bae-4da9-b074-8b8e9d8e50bc')
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Или же можно передать идентификатор представления ресурсу ViewCollection. Пример: …/web/lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/views('0dc42244-4bae-4da9-b074-8b8e9d8e50bc').

Метод GetByTitle

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

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

/getbytitle('<заголовок представления>')

Параметры

Тип: String
Заголовок представления, чувствительный к регистру.

HTTP method

GET

Ответ

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

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

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'da58632f-faf0-4a78-8219-99c307747741')/views
    /getbytitle('By Status')
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

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

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

    {"d":{
      "results":[{
        "__metadata":{
          "id":"https://<site url>/_api/Web/Lists(guid'da58632f-faf0-4a78-8219-99c307747741')/Views(guid'0dc42244-4bae-4da9-b074-8b8e9d8e50bc')",
          "uri":"https://<site url>/_api/Web/Lists(guid'da58632f-faf0-4a78-8219-99c307747741')/Views(guid'0dc42244-4bae-4da9-b074-8b8e9d8e50bc')",
          "type":"SP.View"
        },
        "ViewFields":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'da58632f-faf0-4a78-8219-99c307747741')/Views(guid'0dc42244-4bae-4da9-b074-8b8e9d8e50bc')/ViewFields"}},
        "Aggregations":null,
        "AggregationsStatus":null,
        "BaseViewId":"1",
        "ContentTypeId":{"__metadata":{"type":"SP.ContentTypeId"},"StringValue":"0x"},
        "DefaultView":true,
        "DefaultViewForContentType":false,
        "EditorModified":false,
        "Formats":null,
        "Hidden":false,
        "HtmlSchemaXml":"<View Name=\"{9824C4FF-14FD-4F24-B481-FA33D90F2D85}\" DefaultView=\"TRUE\" MobileView=\"TRUE\" MobileDefaultView=\"TRUE\" Type=\"HTML\" DisplayName=\"All Tasks\" Url=\"/Lists/Backlog items/AllItems.aspx\" Level=\"1\" BaseViewID=\"1\" ContentTypeID=\"0x\" ImageUrl=\"/_layouts/15/images/issuelst.png?rev=31\"><Toolbar Type=\"Standard\" /><ViewFields><FieldRef Name=\"Checkmark\" /><FieldRef Name=\"LinkTitle\" /><FieldRef Name=\"DueDate\" /><FieldRef Name=\"AssignedTo\" /><FieldRef Name=\"Status0\" /></ViewFields><JSLink>hierarchytaskslist.js</JSLink><XslLink Default=\"TRUE\">main.xsl</XslLink><RowLimit Paged=\"TRUE\">100</RowLimit><ViewData><FieldRef Name=\"PercentComplete\" Type=\"StrikeThroughPercentComplete\" /><FieldRef Name=\"DueDate\" Type=\"TimelineDueDate\" /></ViewData></View>"
        "Id":"9824c4ff-14fd-4f24-b481-fa33d90f2d85",
        "ImageUrl":"/_layouts/15/images/issuelst.png?rev=31",
        "IncludeRootFolder":false,
        "ViewJoins":null,
        "JSLink":"hierarchytaskslist.js",
        "ListViewXml":"<View Name=\"{9824C4FF-14FD-4F24-B481-FA33D90F2D85}\" DefaultView=\"TRUE\" MobileView=\"TRUE\" MobileDefaultView=\"TRUE\" Type=\"HTML\" DisplayName=\"All Tasks\" Url=\"/Lists/Backlog items/AllItems.aspx\" Level=\"1\" BaseViewID=\"1\" ContentTypeID=\"0x\" ImageUrl=\"/_layouts/15/images/issuelst.png?rev=31\" ><ViewFields><FieldRef Name=\"Checkmark\" /><FieldRef Name=\"LinkTitle\" /><FieldRef Name=\"DueDate\" /><FieldRef Name=\"AssignedTo\" /><FieldRef Name=\"Status0\" /></ViewFields><RowLimit Paged=\"TRUE\">100</RowLimit><JSLink>hierarchytaskslist.js</JSLink><XslLink Default=\"TRUE\">main.xsl</XslLink><Toolbar Type=\"Standard\"/></View>",
        "Method":null,
        "MobileDefaultView":true,
        "MobileView":true,
        "ModerationType":null,
        "OrderedView":false,
        "Paged":true,
        "PersonalView":false,
        "ViewProjectedFields":null,
        "ViewQuery":null
        "ReadOnlyView":false,
        "RequiresClientIntegration":false,
        "RowLimit":100,
        "Scope":0,
        "ServerRelativeUrl":"/Lists/Backlog items/AllItems.aspx",
        "StyleId":null,
        "Threaded":false,
        "Title":"All Tasks",
        "Toolbar":"",
        "ToolbarTemplateName":null,
        "ViewType":"HTML",
        "ViewData":"<FieldRef Name=\"PercentComplete\" Type=\"StrikeThroughPercentComplete\" /><FieldRef Name=\"DueDate\" Type=\"TimelineDueDate\" />"}}"
      },{
        "__metadata":{
          "id":"https://<site url>/_api/Web/Lists(guid'da58632f-faf0-4a78-8219-99c307747741')/Views(guid'0dc42244-4bae-4da9-b074-8b8e9d8e50bc')",
          "uri":"https://<site url>/_api/Web/Lists(guid'da58632f-faf0-4a78-8219-99c307747741')/Views(guid'0dc42244-4bae-4da9-b074-8b8e9d8e50bc')",
          "type":"SP.View"
        },
        "ViewFields":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'da58632f-faf0-4a78-8219-99c307747741')/Views(guid'0dc42244-4bae-4da9-b074-8b8e9d8e50bc')/ViewFields"}},
        "Aggregations":null,
        "AggregationsStatus":null,
        "BaseViewId":"2",
        "ContentTypeId":{"__metadata":{"type":"SP.ContentTypeId"},"StringValue":"0x"},
        "DefaultView":false,
        "DefaultViewForContentType":false,
        "EditorModified":false,
        "Formats":null,
        "Hidden":false,
        "HtmlSchemaXml":"<View Name=\"{0DC42244-4BAE-4DA9-B074-8B8E9D8E50BC}\" MobileView=\"TRUE\" Type=\"HTML\" DisplayName=\"Late Tasks\" Url=\"/Lists/Backlog items/late.aspx\" Level=\"1\" BaseViewID=\"2\" ContentTypeID=\"0x\" ImageUrl=\"/_layouts/15/images/issuelst.png?rev=31\"><JSLink>hierarchytaskslist.js</JSLink><XslLink Default=\"TRUE\">main.xsl</XslLink><RowLimit Paged=\"TRUE\">100</RowLimit><Toolbar Type=\"Standard\" /><ViewFields><FieldRef Name=\"Checkmark\" /><FieldRef Name=\"LinkTitle\" /><FieldRef Name=\"DueDate\" /><FieldRef Name=\"AssignedTo\" /></ViewFields><ViewData><FieldRef Name=\"PercentComplete\" Type=\"StrikeThroughPercentComplete\" /><FieldRef Name=\"DueDate\" Type=\"TimelineDueDate\" /></ViewData><Query><Where><And><Or><IsNull><FieldRef Name=\"PercentComplete\" /></IsNull><Neq><FieldRef Name=\"PercentComplete\" /><Value Type=\"Number\">1</Value></Neq></Or><Lt><FieldRef Name=\"DueDate\" /><Value Type=\"DateTime\"><Today /></Value></Lt></And></Where><OrderBy><FieldRef Name=\"DueDate\" /><FieldRef Name=\"Priority\" /></OrderBy></Query></View>",
        "Id":"0dc42244-4bae-4da9-b074-8b8e9d8e50bc",
        "ImageUrl":"/_layouts/15/images/issuelst.png?rev=31",
        "IncludeRootFolder":false,
        "ViewJoins":null,
        "JSLink":"hierarchytaskslist.js",
        "ListViewXml":"<View Name=\"{0DC42244-4BAE-4DA9-B074-8B8E9D8E50BC}\" MobileView=\"TRUE\" Type=\"HTML\" DisplayName=\"Late Tasks\" Url=\"/Lists/Backlog items/late.aspx\" Level=\"1\" BaseViewID=\"2\" ContentTypeID=\"0x\" ImageUrl=\"/_layouts/15/images/issuelst.png?rev=31\" ><Query><Where><And><Or><IsNull><FieldRef Name=\"PercentComplete\" /></IsNull><Neq><FieldRef Name=\"PercentComplete\" /><Value Type=\"Number\">1</Value></Neq></Or><Lt><FieldRef Name=\"DueDate\" /><Value Type=\"DateTime\"><Today /></Value></Lt></And></Where><OrderBy><FieldRef Name=\"DueDate\" /><FieldRef Name=\"Priority\" /></OrderBy></Query><ViewFields><FieldRef Name=\"Checkmark\" /><FieldRef Name=\"LinkTitle\" /><FieldRef Name=\"DueDate\" /><FieldRef Name=\"AssignedTo\" /></ViewFields><RowLimit Paged=\"TRUE\">100</RowLimit><JSLink>hierarchytaskslist.js</JSLink><XslLink Default=\"TRUE\">main.xsl</XslLink><Toolbar Type=\"Standard\"/></View>",
        "Method":null,
        "MobileDefaultView":false,
        "MobileView":true,
        "ModerationType":null,
        "OrderedView":false,
        "Paged":true,
        "PersonalView":false,
        "ViewProjectedFields":null,
        "ViewQuery":"<Where><And><Or><IsNull><FieldRef Name=\"PercentComplete\" /></IsNull><Neq><FieldRef Name=\"PercentComplete\" /><Value Type=\"Number\">1</Value></Neq></Or><Lt><FieldRef Name=\"DueDate\" /><Value Type=\"DateTime\"><Today /></Value></Lt></And></Where><OrderBy><FieldRef Name=\"DueDate\" /><FieldRef Name=\"Priority\" /></OrderBy>",
        "ReadOnlyView":false,
        "RequiresClientIntegration":false,
        "RowLimit":100,
        "Scope":0,
        "ServerRelativeUrl":"/Lists/Backlog items/late.aspx",
        "StyleId":null,
        "Threaded":false,
        "Title":"Late Tasks",
        "Toolbar":"",
        "ToolbarTemplateName":null,
        "ViewType":"HTML",
        "ViewData":"<FieldRef Name=\"PercentComplete\" Type=\"StrikeThroughPercentComplete\" /><FieldRef Name=\"DueDate\" Type=\"TimelineDueDate\" />"
      },{
        …
      }]
    }}

Ресурс ViewFieldCollection

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

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

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

http://<адрес сайта>/_api/web/lists(guid'<идентификатор списка>')/views('<идентификатор представления>')/viewfields

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

GET  |  POST

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

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

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /views('d82d3e67-f317-413c-8f27-590317a40f20')/viewfields
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Свойства ViewFieldCollection

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

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /views('d82d3e67-f317-413c-8f27-590317a40f20')/viewfields/schemaxml
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Свойство

Тип

R/W

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

Описание

SchemaXml

String

R

Да

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

Items

Collection(String)

R

Да

Задает схему XML коллекции полей. Свойство Items возвращается вместе с ресурсом, но у него нет конечной точки, адресуемой по URI.

Методы ViewFieldCollection

AddViewField
MoveViewFieldTo
RemoveAllViewFields
RemoveViewField

Метод AddViewField

Добавляет поле с указанным внутренним или отображаемым именем в коллекцию.

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

/addviewfield('<имя поля>')

Параметры

Тип: String
Чувствительное к регистру внутреннее имя или отображаемое имя добавляемого поля.

HTTP method

POST

Ответ

Нет

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

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /views('d82d3e67-f317-413c-8f27-590317a40f20')/viewfields
    /addviewfield('AssignedTo')
    ?@target='<host web url>'",
  method: "POST",
  success: successHandler,
  error: errorHandler
});

Метод MoveViewFieldTo

Перемещает поле с указанным внутренним именем в коллекции на указанную позицию.

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

/moveviewfieldto

Параметры

field

Тип: String
Чувствительное к регистру внутреннее имя перемещаемого поля. Отправляйте этот параметр и параметр index в теле запроса, как показано в примере.

index

Тип: Int32
Индекс новой позиции поля с отсчетом от нуля. Отправляйте этот параметр и параметр field в теле запроса, как показано в примере.

HTTP method

POST

Ответ

Нет

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

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /views('d82d3e67-f317-413c-8f27-590317a40f20')/viewfields
    /moveviewfieldto
    ?@target='<host web url>'",
  method: "POST",
  body: "{ 'field': 'DueDate', 'index': 0 }",
  headers: { "content-type": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Метод RemoveAllViewFields

Удаляет все поля из коллекции.

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

/removeallviewfields

Параметры

Нет

HTTP method

POST

Ответ

Нет

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

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /views('d82d3e67-f317-413c-8f27-590317a40f20')/viewfields
    /removeallviewfields
    ?@target='<host web url>'",
  method: "POST",
  success: successHandler,
  error: errorHandler
});

Метод RemoveViewField

Удаляет поле с указанным внутренним именем из коллекции.

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

/removeviewfield('<имя поля>')

Параметры

Тип: String
Чувствительное к регистру внутреннее имя поля, удаляемого из представления.

HTTP method

POST

Ответ

Нет

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

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /views('d82d3e67-f317-413c-8f27-590317a40f20')/viewfields
    /removeviewfield('AssignedTo')
    ?@target='<host web url>'",
  method: "POST",
  success: successHandler,
  error: errorHandler
});

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

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

    {"d":{
      "__metadata":{
        "id":"https://<site url>/_api/SP.AppContextSite(@target)/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/views('d82d3e67-f317-413c-8f27-590317a40f20')/viewfields",
        "uri":"https://<site url>/_api/SP.AppContextSite(@target)/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/views('d82d3e67-f317-413c-8f27-590317a40f20')/viewfields",
        "type":"SP.ViewFieldCollection"
      },
      "SchemaXml":"<FieldRef Name=\"Checkmark\" /><FieldRef Name=\"Status\" /><FieldRef Name=\"LinkTitle\" /><FieldRef Name=\"DueDate\" />",
      "Items":{"results":["Checkmark", "Status", "LinkTitle", "DueDate"]}
    }}

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