Работа со списками и элементами списков с использованием RESTWorking with lists and list items with REST

Совет

Служба REST в SharePoint Online (а также локальной среде SharePoint 2016 или более поздней версии) поддерживает объединение нескольких запросов в один вызов службы с помощью параметра запроса OData $batch.The SharePoint Online (and on-premises SharePoint 2016 and later) REST service supports combining multiple requests into a single call to the service by using the OData $batch query option. Подробные сведения и ссылки на примеры кода см. в статье Отправка пакетных запросов с помощью интерфейсов REST API.For details and links to code samples, see Make batch requests with the REST APIs.

Необходимые компонентыPrerequisites

В этой статье предполагается, что вы уже ознакомились со статьями Знакомство со службой REST для SharePoint и Выполнение базовых операций с использованием конечных точек REST в SharePoint.This topic assumes that you are already familiar with the topics Get to know the SharePoint REST service and Complete basic operations using SharePoint REST endpoints. Здесь не представлены фрагменты кода.It does not provide code snippets.

Получение списков и свойств списков с помощью RESTRetrieving lists and list properties with REST

В следующем примере показано, как получить определенный список, если вы знаете его GUID .The following example shows how to retrieve a specific list if you know its GUID.

url: http://site url/_api/web/lists(guid'list GUID'),
method: GET
Headers:
    Authorization: "Bearer " + accessToken
    accept: "application/json;odata=verbose" or "application/atom+xml"

Примечание

Если вы хотите получить отклик в формате JSON, укажите application/json;odata=verbose в заголовке accept.If you want the response in JSON, use application/json;odata=verbose in the accept header .

Если вы хотите получить отклик в формате Atom, укажите application/atom+xml в заголовке accept.If you want the response in Atom format, use application/atom+xml in the accept header.


В следующем примере показано, как получить определенный список, если вы знаете его название.The following example shows how to retrieve a specific list if you know its title.

url: http://site url/_api/web/lists/GetByTitle('Test')
method: GET
Headers:
    Authorization: "Bearer " + accessToken
    accept: "application/json;odata=verbose" or "application/atom+xml"


Следующий XML показывает пример свойств списка, которые возвращаются при запросе конXML.The following XML shows an example of the list properties that are returned when you request the XML content type.

  <content type="application/xml">
  <m:properties>
  <d:AllowContentTypes m:type="Edm.Boolean">true</d:AllowContentTypes> 
  <d:BaseTemplate m:type="Edm.Int32">100</d:BaseTemplate> 
  <d:BaseType m:type="Edm.Int32">0</d:BaseType> 
  <d:ContentTypesEnabled m:type="Edm.Boolean">false</d:ContentTypesEnabled> 
  <d:Created m:type="Edm.DateTime">2012-06-26T23:15:58Z</d:Created> 
  <d:DefaultContentApprovalWorkflowId m:type="Edm.Guid">00000000-0000-0000-0000-000000000000</d:DefaultContentApprovalWorkflowId> 
  <d:Description>A list created by Project Based Retention used to store Project Policy Items.</d:Description> 
  <d:Direction>none</d:Direction> 
  <d:DocumentTemplateUrl m:null="true" /> 
  <d:DraftVersionVisibility m:type="Edm.Int32">0</d:DraftVersionVisibility> 
  <d:EnableAttachments m:type="Edm.Boolean">true</d:EnableAttachments> 
  <d:EnableFolderCreation m:type="Edm.Boolean">false</d:EnableFolderCreation> 
  <d:EnableMinorVersions m:type="Edm.Boolean">false</d:EnableMinorVersions> 
  <d:EnableModeration m:type="Edm.Boolean">false</d:EnableModeration> 
  <d:EnableVersioning m:type="Edm.Boolean">false</d:EnableVersioning> 
  <d:EntityTypeName>ProjectPolicyItemList</d:EntityTypeName> 
  <d:ForceCheckout m:type="Edm.Boolean">false</d:ForceCheckout> 
  <d:HasExternalDataSource m:type="Edm.Boolean">false</d:HasExternalDataSource> 
  <d:Hidden m:type="Edm.Boolean">true</d:Hidden> 
  <d:Id m:type="Edm.Guid">74de3ff3-029c-42f9-bd2a-1e9463def69d</d:Id> 
  <d:ImageUrl>/_layouts/15/images/itgen.gif</d:ImageUrl> 
  <d:IrmEnabled m:type="Edm.Boolean">false</d:IrmEnabled> 
  <d:IrmExpire m:type="Edm.Boolean">false</d:IrmExpire> 
  <d:IrmReject m:type="Edm.Boolean">false</d:IrmReject> 
  <d:IsApplicationList m:type="Edm.Boolean">false</d:IsApplicationList> 
  <d:IsCatalog m:type="Edm.Boolean">false</d:IsCatalog> 
  <d:IsPrivate m:type="Edm.Boolean">false</d:IsPrivate> 
  <d:ItemCount m:type="Edm.Int32">0</d:ItemCount> 
  <d:LastItemDeletedDate m:type="Edm.DateTime">2012-06-26T23:15:58Z</d:LastItemDeletedDate> 
  <d:LastItemModifiedDate m:type="Edm.DateTime">2012-06-26T23:15:59Z</d:LastItemModifiedDate> 
  <d:ListItemEntityTypeFullName>SP.Data.ProjectPolicyItemListItem</d:ListItemEntityTypeFullName> 
  <d:MultipleDataList m:type="Edm.Boolean">false</d:MultipleDataList> 
  <d:NoCrawl m:type="Edm.Boolean">true</d:NoCrawl> 
  <d:ParentWebUrl>/</d:ParentWebUrl> 
  <d:ServerTemplateCanCreateFolders m:type="Edm.Boolean">true</d:ServerTemplateCanCreateFolders> 
  <d:TemplateFeatureId m:type="Edm.Guid">00bfea71-de22-43b2-a848-c05709900100</d:TemplateFeatureId> 
  <d:Title>Project Policy Item List</d:Title> 
  </m:properties>
  </content>

Примечание

Свойство ListItemEntityTypeFullName (в предыдущем примере — SP.Data.ProjectPolicyItemListItem) особенно важно, если вы хотите создать и обновить элементы списка.The ListItemEntityTypeFullName property (SP.Data.ProjectPolicyItemListItem in the previous example) is especially important if you want to create and update list items. Это значение должно передаваться в виде свойства type в тексте HTTP-запроса каждый раз, когда вы создаете и обновляете элементы списка.This value must be passed as the type property in the metadata that you pass in the body of the HTTP request whenever you create and update list items.


Работа со списками с помощью RESTWorking with lists by using REST

В приведенном ниже примере показано, как создать список.The following example shows how to create a list.

url: http://site url/_api/web/lists
method: POST
body: { '__metadata': { 'type': 'SP.List' }, 'AllowContentTypes': true, 'BaseTemplate': 100,
 'ContentTypesEnabled': true, 'Description': 'My list description', 'Title': 'Test' }
Headers: 
    Authorization: "Bearer " + accessToken
    X-RequestDigest: form digest value
    accept: "application/json;odata=verbose"
    content-type: "application/json;odata=verbose"
    content-length:length of post body


В приведенном ниже примере показано, как обновить список, используя метод MERGE.The following example shows how to update a list by using the MERGE method.

url: http://site url/_api/web/lists(guid'list GUID')
method: POST
body: { '__metadata': { 'type': 'SP.List' }, 'Title': 'New title' }
Headers: 
    Authorization: "Bearer " + accessToken
    X-RequestDigest: form digest value
    IF-MATCH": etag or "*"
    X-HTTP-Method: MERGE,
    accept: "application/json;odata=verbose"
    content-type: "application/json;odata=verbose"
    content-length:length of post body


В приведенном ниже примере показано, как создать настраиваемое поле для списка.The following example shows how to create a custom field for a list.

Url: url: http://site url/_api/web/lists(guid'list GUID')/Fields
Method:POST
Body: { '__metadata': { 'type': 'SP.Field' }, 'Title': 'field title', 'FieldTypeKind': FieldType value,'Required': 'true/false', 'EnforceUniqueValues': 'true/false','StaticName': 'field name'}
Headers: 
    Authorization: "Bearer " + accessToken
    X-RequestDigest: form digest value
    content-type: "application/json;odata=verbose"
    content-length:length of post body


В приведенном ниже примере показано, как удалить список.The following example shows how to delete a list.

url: http://site url/_api/web/lists(guid'list GUID')
method: POST
Headers: 
    Authorization: "Bearer " + accessToken
    X-RequestDigest: form digest value
    IF-MATCH: etag or "*"
    X-HTTP-Method: DELETE


Работа с элементами списка с помощью RESTWorking with list items by using REST

Получение всех элементов спискаRetrieve all list items

В следующем примере показано, как получить все элементы списка.The following example shows how to retrieve all of a list's items.

Примечание

Параметр запроса OData $skip не работает при запросе элементов списка.The OData $skip query option does not work when querying list items. Обычно вместо него можно использовать параметр $skiptoken.In may situations, you can use the $skiptoken option instead.

url: http://site url/_api/web/lists/GetByTitle('Test')/items
method: GET
headers:
    Authorization: "Bearer " + accessToken
    accept: "application/json;odata=verbose" or "application/atom+xml"

Получение определенного элемента спискаRetrieve specific list item

Ниже показано, как получить определенный элемент списка.The following example shows how to retrieve a specific list item.

url: http://site url/_api/web/lists/GetByTitle('Test')/items(item id)
method: GET
headers:
    Authorization: "Bearer " + accessToken
    accept: "application/json;odata=verbose" or "application/atom+xml"


Ниже показан пример свойств элементов списка, которые возвращаются при запросе типа контента XML.The following XML shows an example of the list item properties that are returned when you request the XML content type.

<content type="application/xml">
<m:properties> 
<d:FileSystemObjectType m:type="Edm.Int32">0</d:FileSystemObjectType>
<d:Id m:type="Edm.Int32">1</d:Id>
<d:ID m:type="Edm.Int32">1</d:ID>
<d:ContentTypeId>0x010049564F321A0F0543BA8C6303316C8C0F</d:ContentTypeId>
<d:Title>an item</d:Title>
<d:Modified m:type="Edm.DateTime">2012-07-24T22:47:26Z</d:Modified>
<d:Created m:type="Edm.DateTime">2012-07-24T22:47:26Z</d:Created>
<d:AuthorId m:type="Edm.Int32">11</d:AuthorId>
<d:EditorId m:type="Edm.Int32">11</d:EditorId>
<d:OData__UIVersionString>1.0</d:OData__UIVersionString>
<d:Attachments m:type="Edm.Boolean">false</d:Attachments>
<d:GUID m:type="Edm.Guid">eb6850c5-9a30-4636-b282-234eda8b1057</d:GUID>
</m:properties>
</content>

Получение элементов в виде потокаRetrieve items as a stream

Извлекает сведения о списке и его данных.Retrieves information about the list and its data. С помощью этой API можно получить элементы списка, если они используют сложные поля, например количество просмотров или управляемые метаданные.Using this API you can retrieve list items in case they use complex fields such as lookups or managed metadata.

POST /_api/web/GetList(@listUrl)/RenderListDataAsStream?@listUrl=%27%2Fsites%2Fteam-a%2Flists%2FList%27

Параметры URIURI Parameters

Следующие свойства можно добавлять в качестве параметров строки запроса для операций с возвращаемыми данными.Following properties can be added as query string parameters to manipulate the returned data.

СвойствоProperty ОписаниеDescription ТипType ПримерExample
CascDelWarnMessage Указывает, должно ли отображаться сообщение при наличии предупреждения о каскадном удаленииSpecifies if a message should be displayed if there is a cascade deletion warning числоnumber 1
DrillDown Указывает, что в сгруппированном представлении некоторые группы развернуты.Specifies that some groups in a grouped view is expanded. Используется вместе с GroupString.Used with GroupString. строкаstring
GroupString Идентификатор группы, используемый для функции детализации.Group identifier used for drill down feature. строкаstring
HasOverrideSelectCommand Позволяет убедиться в наличии определенных полей, необходимых для правильной работы элементов управления SharePoint ListView.Used to ensure that certain fields are present for proper functioning of the SharePoint ListView control. строкаstring
Field Указывает специальное поле, которое следует включить.Specifies a special field that should be included. строкаstring
FieldInternalName Используется для выявления поля, когда список содержит внешний источник данных.Used to identify a field when a list has an external data source. Также используется при фильтрации для настраиваемого поля.Also used when filtering on a custom field. строкаstring
Filter Указывает, следует ли применять фильтр для запрошенного представления.Specifies whether the requested view should have a filter applied. строкаstring
FilterData Данные, задаваемые определенным фильтром.Data specified by a particular filter. строкаstring
FilterData1 Данные, задаваемые определенным фильтром.Data specified by a particular filter. строкаstring
FilterData2 Данные, задаваемые определенным фильтром.Data specified by a particular filter. строкаstring
FilterData3 Данные, задаваемые определенным фильтром.Data specified by a particular filter. строкаstring
FilterData4 Данные, задаваемые определенным фильтром.Data specified by a particular filter. строкаstring
FilterData5 Данные, задаваемые определенным фильтром.Data specified by a particular filter. строкаstring
FilterData6 Данные, задаваемые определенным фильтром.Data specified by a particular filter. строкаstring
FilterData7 Данные, задаваемые определенным фильтром.Data specified by a particular filter. строкаstring
FilterData8 Данные, задаваемые определенным фильтром.Data specified by a particular filter. строкаstring
FilterData9 Данные, задаваемые определенным фильтром.Data specified by a particular filter. строкаstring
FilterData10 Данные, задаваемые определенным фильтром.Data specified by a particular filter. строкаstring
FilterField Имя поля фильтра для определенного фильтра, который применяется к представлению.A filter field name for a specific filter that is applied to the view. строкаstring
FilterField1 Имя поля фильтра для определенного фильтра, который применяется к представлению.A filter field name for a specific filter that is applied to the view. строкаstring ID
FilterField2 Имя поля фильтра для определенного фильтра, который применяется к представлению.A filter field name for a specific filter that is applied to the view. строкаstring ID
FilterField3 Имя поля фильтра для определенного фильтра, который применяется к представлению.A filter field name for a specific filter that is applied to the view. строкаstring ID
FilterField4 Имя поля фильтра для определенного фильтра, который применяется к представлению.A filter field name for a specific filter that is applied to the view. строкаstring ID
FilterField5 Имя поля фильтра для определенного фильтра, который применяется к представлению.A filter field name for a specific filter that is applied to the view. строкаstring ID
FilterField6 Имя поля фильтра для определенного фильтра, который применяется к представлению.A filter field name for a specific filter that is applied to the view. строкаstring ID
FilterField7 Имя поля фильтра для определенного фильтра, который применяется к представлению.A filter field name for a specific filter that is applied to the view. строкаstring ID
FilterField8 Имя поля фильтра для определенного фильтра, который применяется к представлению.A filter field name for a specific filter that is applied to the view. строкаstring ID
FilterField9 Имя поля фильтра для определенного фильтра, который применяется к представлению.A filter field name for a specific filter that is applied to the view. строкаstring ID
FilterField10 Имя поля фильтра для определенного фильтра, который применяется к представлению.A filter field name for a specific filter that is applied to the view. строкаstring ID
FilterFields Определяет несколько полей, которые будут фильтроваться множественным фильтром.Specifies multiple fields that are being filtered on for a multiplier filter. строкаstring
FilterFields1 Определяет несколько полей, которые будут фильтроваться множественным фильтром.Specifies multiple fields that are being filtered on for a multiplier filter. строкаstring
FilterFields2 Определяет несколько полей, которые будут фильтроваться множественным фильтром.Specifies multiple fields that are being filtered on for a multiplier filter. строкаstring
FilterFields3 Определяет несколько полей, которые будут фильтроваться множественным фильтром.Specifies multiple fields that are being filtered on for a multiplier filter. строкаstring
FilterFields4 Определяет несколько полей, которые будут фильтроваться множественным фильтром.Specifies multiple fields that are being filtered on for a multiplier filter. строкаstring
FilterFields5 Определяет несколько полей, которые будут фильтроваться множественным фильтром.Specifies multiple fields that are being filtered on for a multiplier filter. строкаstring
FilterFields6 Определяет несколько полей, которые будут фильтроваться множественным фильтром.Specifies multiple fields that are being filtered on for a multiplier filter. строкаstring
FilterFields7 Определяет несколько полей, которые будут фильтроваться множественным фильтром.Specifies multiple fields that are being filtered on for a multiplier filter. строкаstring
FilterFields8 Определяет несколько полей, которые будут фильтроваться множественным фильтром.Specifies multiple fields that are being filtered on for a multiplier filter. строкаstring
FilterFields9 Определяет несколько полей, которые будут фильтроваться множественным фильтром.Specifies multiple fields that are being filtered on for a multiplier filter. строкаstring
FilterFields10 Определяет несколько полей, которые будут фильтроваться множественным фильтром.Specifies multiple fields that are being filtered on for a multiplier filter. строкаstring
FilterValue Значение фильтра, связанное с определенным фильтром.The filter value associated with a particular filter. Пример: FilterField3 соотносится с FilterValue3 и т. д.For example, FilterField3 goes with FilterValue3 and so forth. строкаstring
FilterValue1 Значение фильтра, связанное с определенным фильтром.The filter value associated with a particular filter. Пример: FilterField3 соотносится с FilterValue3 и т. д.For example, FilterField3 goes with FilterValue3 and so forth. строкаstring 1
FilterValue2 Значение фильтра, связанное с определенным фильтром.The filter value associated with a particular filter. Пример: FilterField3 соотносится с FilterValue3 и т. д.For example, FilterField3 goes with FilterValue3 and so forth. строкаstring 1
FilterValue3 Значение фильтра, связанное с определенным фильтром.The filter value associated with a particular filter. Пример: FilterField3 соотносится с FilterValue3 и т. д.For example, FilterField3 goes with FilterValue3 and so forth. строкаstring 1
FilterValue4 Значение фильтра, связанное с определенным фильтром.The filter value associated with a particular filter. Пример: FilterField3 соотносится с FilterValue3 и т. д.For example, FilterField3 goes with FilterValue3 and so forth. строкаstring 1
FilterValue5 Значение фильтра, связанное с определенным фильтром.The filter value associated with a particular filter. Пример: FilterField3 соотносится с FilterValue3 и т. д.For example, FilterField3 goes with FilterValue3 and so forth. строкаstring 1
FilterValue6 Значение фильтра, связанное с определенным фильтром.The filter value associated with a particular filter. Пример: FilterField3 соотносится с FilterValue3 и т. д.For example, FilterField3 goes with FilterValue3 and so forth. строкаstring 1
FilterValue7 Значение фильтра, связанное с определенным фильтром.The filter value associated with a particular filter. Пример: FilterField3 соотносится с FilterValue3 и т. д.For example, FilterField3 goes with FilterValue3 and so forth. строкаstring 1
FilterValue8 Значение фильтра, связанное с определенным фильтром.The filter value associated with a particular filter. Пример: FilterField3 соотносится с FilterValue3 и т. д.For example, FilterField3 goes with FilterValue3 and so forth. строкаstring 1
FilterValue9 Значение фильтра, связанное с определенным фильтром.The filter value associated with a particular filter. Пример: FilterField3 соотносится с FilterValue3 и т. д.For example, FilterField3 goes with FilterValue3 and so forth. строкаstring 1
FilterValue10 Значение фильтра, связанное с определенным фильтром.The filter value associated with a particular filter. Пример: FilterField3 соотносится с FilterValue3 и т. д.For example, FilterField3 goes with FilterValue3 and so forth. строкаstring 1
FilterValues Используется с FilterFields для множественного фильтра.Used with FilterFields for multiplier filter. Пример: FilterFields3 соотносится с FilterValues3 и т. д.For example, FilterFields3 would go with FilterValues3 and so forth. строкаstring
FilterValues1 Используется с FilterFields для множественного фильтра.Used with FilterFields for multiplier filter. Пример: FilterFields3 соотносится с FilterValues3 и т. д.For example, FilterFields3 would go with FilterValues3 and so forth. строкаstring
FilterValues2 Используется с FilterFields для множественного фильтра.Used with FilterFields for multiplier filter. Пример: FilterFields3 соотносится с FilterValues3 и т. д.For example, FilterFields3 would go with FilterValues3 and so forth. строкаstring
FilterValues3 Используется с FilterFields для множественного фильтра.Used with FilterFields for multiplier filter. Пример: FilterFields3 соотносится с FilterValues3 и т. д.For example, FilterFields3 would go with FilterValues3 and so forth. строкаstring
FilterValues4 Используется с FilterFields для множественного фильтра.Used with FilterFields for multiplier filter. Пример: FilterFields3 соотносится с FilterValues3 и т. д.For example, FilterFields3 would go with FilterValues3 and so forth. строкаstring
FilterValues5 Используется с FilterFields для множественного фильтра.Used with FilterFields for multiplier filter. Пример: FilterFields3 соотносится с FilterValues3 и т. д.For example, FilterFields3 would go with FilterValues3 and so forth. строкаstring
FilterValues6 Используется с FilterFields для множественного фильтра.Used with FilterFields for multiplier filter. Пример: FilterFields3 соотносится с FilterValues3 и т. д.For example, FilterFields3 would go with FilterValues3 and so forth. строкаstring
FilterValues7 Используется с FilterFields для множественного фильтра.Used with FilterFields for multiplier filter. Пример: FilterFields3 соотносится с FilterValues3 и т. д.For example, FilterFields3 would go with FilterValues3 and so forth. строкаstring
FilterValues8 Используется с FilterFields для множественного фильтра.Used with FilterFields for multiplier filter. Пример: FilterFields3 соотносится с FilterValues3 и т. д.For example, FilterFields3 would go with FilterValues3 and so forth. строкаstring
FilterValues9 Используется с FilterFields для множественного фильтра.Used with FilterFields for multiplier filter. Пример: FilterFields3 соотносится с FilterValues3 и т. д.For example, FilterFields3 would go with FilterValues3 and so forth. строкаstring
FilterValues10 Используется с FilterFields для множественного фильтра.Used with FilterFields for multiplier filter. Пример: FilterFields3 соотносится с FilterValues3 и т. д.For example, FilterFields3 would go with FilterValues3 and so forth. строкаstring
FilterLookupId Используется при фильтрации для поля подстановки.Used when filtering on a lookup field. Это идентификатор элемента во внешнем списке, содержащий значение, по которому выполняется фильтрация.This is the item id in the foreign list that has a value that is being filtered on. строкаstring
FilterLookupId1 Используется при фильтрации для поля подстановки.Used when filtering on a lookup field. Это идентификатор элемента во внешнем списке, содержащий значение, по которому выполняется фильтрация.This is the item id in the foreign list that has a value that is being filtered on. строкаstring
FilterLookupId2 Используется при фильтрации для поля подстановки.Used when filtering on a lookup field. Это идентификатор элемента во внешнем списке, содержащий значение, по которому выполняется фильтрация.This is the item id in the foreign list that has a value that is being filtered on. строкаstring
FilterLookupId3 Используется при фильтрации для поля подстановки.Used when filtering on a lookup field. Это идентификатор элемента во внешнем списке, содержащий значение, по которому выполняется фильтрация.This is the item id in the foreign list that has a value that is being filtered on. строкаstring
FilterLookupId4 Используется при фильтрации для поля подстановки.Used when filtering on a lookup field. Это идентификатор элемента во внешнем списке, содержащий значение, по которому выполняется фильтрация.This is the item id in the foreign list that has a value that is being filtered on. строкаstring
FilterLookupId5 Используется при фильтрации для поля подстановки.Used when filtering on a lookup field. Это идентификатор элемента во внешнем списке, содержащий значение, по которому выполняется фильтрация.This is the item id in the foreign list that has a value that is being filtered on. строкаstring
FilterLookupId6 Используется при фильтрации для поля подстановки.Used when filtering on a lookup field. Это идентификатор элемента во внешнем списке, содержащий значение, по которому выполняется фильтрация.This is the item id in the foreign list that has a value that is being filtered on. строкаstring
FilterLookupId7 Используется при фильтрации для поля подстановки.Used when filtering on a lookup field. Это идентификатор элемента во внешнем списке, содержащий значение, по которому выполняется фильтрация.This is the item id in the foreign list that has a value that is being filtered on. строкаstring
FilterLookupId8 Используется при фильтрации для поля подстановки.Used when filtering on a lookup field. Это идентификатор элемента во внешнем списке, содержащий значение, по которому выполняется фильтрация.This is the item id in the foreign list that has a value that is being filtered on. строкаstring
FilterLookupId9 Используется при фильтрации для поля подстановки.Used when filtering on a lookup field. Это идентификатор элемента во внешнем списке, содержащий значение, по которому выполняется фильтрация.This is the item id in the foreign list that has a value that is being filtered on. строкаstring
FilterLookupId10 Используется при фильтрации для поля подстановки.Used when filtering on a lookup field. Это идентификатор элемента во внешнем списке, содержащий значение, по которому выполняется фильтрация.This is the item id in the foreign list that has a value that is being filtered on. строкаstring
FilterOnly строкаstring
FilterOp Оператор фильтра.Filter operator. Используется при фильтрации с операторами, отличными от Eq (Geq, Leq и т. д.)Used when filtering with other operators than Eq (Geq, Leq etc.) строкаstring Geq
FilterOp1 Оператор фильтра.Filter operator. Используется при фильтрации с операторами, отличными от Eq (Geq, Leq и т. д.)Used when filtering with other operators than Eq (Geq, Leq etc.) строкаstring Geq
FilterOp2 Оператор фильтра.Filter operator. Используется при фильтрации с операторами, отличными от Eq (Geq, Leq и т. д.)Used when filtering with other operators than Eq (Geq, Leq etc.) строкаstring Geq
FilterOp3 Оператор фильтра.Filter operator. Используется при фильтрации с операторами, отличными от Eq (Geq, Leq и т. д.)Used when filtering with other operators than Eq (Geq, Leq etc.) строкаstring Geq
FilterOp4 Оператор фильтра.Filter operator. Используется при фильтрации с операторами, отличными от Eq (Geq, Leq и т. д.)Used when filtering with other operators than Eq (Geq, Leq etc.) строкаstring Geq
FilterOp5 Оператор фильтра.Filter operator. Используется при фильтрации с операторами, отличными от Eq (Geq, Leq и т. д.)Used when filtering with other operators than Eq (Geq, Leq etc.) строкаstring Geq
FilterOp6 Оператор фильтра.Filter operator. Используется при фильтрации с операторами, отличными от Eq (Geq, Leq и т. д.)Used when filtering with other operators than Eq (Geq, Leq etc.) строкаstring Geq
FilterOp7 Оператор фильтра.Filter operator. Используется при фильтрации с операторами, отличными от Eq (Geq, Leq и т. д.)Used when filtering with other operators than Eq (Geq, Leq etc.) строкаstring Geq
FilterOp8 Оператор фильтра.Filter operator. Используется при фильтрации с операторами, отличными от Eq (Geq, Leq и т. д.)Used when filtering with other operators than Eq (Geq, Leq etc.) строкаstring Geq
FilterOp9 Оператор фильтра.Filter operator. Используется при фильтрации с операторами, отличными от Eq (Geq, Leq и т. д.)Used when filtering with other operators than Eq (Geq, Leq etc.) строкаstring Geq
FilterOp10 Оператор фильтра.Filter operator. Используется при фильтрации с операторами, отличными от Eq (Geq, Leq и т. д.)Used when filtering with other operators than Eq (Geq, Leq etc.) строкаstring Geq
ID Идентификатор элемента, сведения о котором являются целью поиска.The item id of the item whose information is being sought. числоnumber
InplaceSearchQuery Условие поиска для поиска по полному списку.Search term for a full list search. строкаstring
InplaceFullListSearch Логическое значение, определяющее, является ли это поиском по полному списку.A boolean that specifies whether there is a full list search. строкаstring
IsCSR Указывает, является ли это представление клиентским представлением.Whether this view is a client side rendered view. строкаstring
CustomAction строкаstring
IsGroupRender Используется для задания свойства IsGroupRender для SPView.Used to set the IsGroupRender property of the SPView. строкаstring
IsRibbon строкаstring
IsXslView Указывает, является ли это представление представлением списка xslt.Whether this view is an xslt list view. строкаstring
List строкаstring
ListId строкаstring
ListViewPageUrl строкаstring
OverrideScope Используется для переопределения области в отображаемом представлении: SPView.ScopeUsed to override a scope on the rendered view: SPView.Scope строкаstring
OverrideSelectCommand Используется для подтверждения наличия определенных полей в запросе, независимо от того, добавлены ли они явным образом в представление.Used to make sure that certain fields are present in the query regardless of whether they are explicitly included in the view. строкаstring
PageFirstRow Запрашиваемые сведения о разбиении на страницы для первой строки.Paging information about the first row that is requested. Используется для представлений списков с разбивкой на страницы.Used for paging list views. строкаstring
PageLastRow Запрашиваемые сведения о разбиении на страницы для последней строки.Paging information about the last row that is requested. Используется для представлений списков с разбивкой на страницы.Used for paging list views. строкаstring
RootFolder Папка, в которой отображается представление.The folder that the view is displaying. строкаstring
SortField Поле, по которому должно быть отсортировано представление.A field that the view should be sorted on. строкаstring ID
SortField1 Поле, по которому должно быть отсортировано представление.A field that the view should be sorted on. строкаstring ID
SortField2 Поле, по которому должно быть отсортировано представление.A field that the view should be sorted on. строкаstring ID
SortField3 Поле, по которому должно быть отсортировано представление.A field that the view should be sorted on. строкаstring ID
SortField4 Поле, по которому должно быть отсортировано представление.A field that the view should be sorted on. строкаstring ID
SortField5 Поле, по которому должно быть отсортировано представление.A field that the view should be sorted on. строкаstring ID
SortField6 Поле, по которому должно быть отсортировано представление.A field that the view should be sorted on. строкаstring ID
SortField7 Поле, по которому должно быть отсортировано представление.A field that the view should be sorted on. строкаstring ID
SortField8 Поле, по которому должно быть отсортировано представление.A field that the view should be sorted on. строкаstring ID
SortField9 Поле, по которому должно быть отсортировано представление.A field that the view should be sorted on. строкаstring ID
SortField10 Поле, по которому должно быть отсортировано представление.A field that the view should be sorted on. строкаstring ID
SortFields Задает имя первого поля для выполнения сортировкиSpecifies the name of the first field to sort by строкаstring
SortFieldValues Задает имя первого поля для выполнения сортировкиSpecifies the name of the first field to sort by строкаstring
SortDir Направление специальной сортировки, применяемой для представления.The sort direction of an ad hoc sort that is being applied to the view. строкаstring Desc
SortDir1 Направление специальной сортировки, применяемой для представления.The sort direction of an ad hoc sort that is being applied to the view. строкаstring Desc
SortDir2 Направление специальной сортировки, применяемой для представления.The sort direction of an ad hoc sort that is being applied to the view. строкаstring Desc
SortDir3 Направление специальной сортировки, применяемой для представления.The sort direction of an ad hoc sort that is being applied to the view. строкаstring Desc
SortDir4 Направление специальной сортировки, применяемой для представления.The sort direction of an ad hoc sort that is being applied to the view. строкаstring Desc
SortDir5 Направление специальной сортировки, применяемой для представления.The sort direction of an ad hoc sort that is being applied to the view. строкаstring Desc
SortDir6 Направление специальной сортировки, применяемой для представления.The sort direction of an ad hoc sort that is being applied to the view. строкаstring Desc
SortDir7 Направление специальной сортировки, применяемой для представления.The sort direction of an ad hoc sort that is being applied to the view. строкаstring Desc
SortDir8 Направление специальной сортировки, применяемой для представления.The sort direction of an ad hoc sort that is being applied to the view. строкаstring Desc
SortDir9 Направление специальной сортировки, применяемой для представления.The sort direction of an ad hoc sort that is being applied to the view. строкаstring Desc
SortDir10 Направление специальной сортировки, применяемой для представления.The sort direction of an ad hoc sort that is being applied to the view. строкаstring Desc
View Определяет базовое представление, которое будет использоваться для отображения списка.Specifies the base view that will be used to render the list. Идентификатор GUIDGUID 3d13559e-3071-5000-76b8-8f1ca6b835f0
ViewPath Определяет путь представления, который будет использоваться для отображения списка.Specifies the path of the view that will be used to render the list. Если присвоен ViewId, то будет применяться ViewId, и эти параметры будут игнорироваться.If ViewId is given then the ViewId will be used and this parameters will be ignored. строкаstring
ViewCount Если на странице несколько представлений списков, то этот параметр указывает один из них.When multiple list views are on a page, this identifies one of them. строкаstring
ViewId Определяет базовое представление, которое будет использоваться для отображения списка.Specifies the base view that will be used to render the list. специальные параметры будут применены в верхней части этого представления.ad-hoc parameters will be applied on top of this view. Если присвоены ViewXml и BaseViewId, то будет применяться ViewXml, и специальные параметры будут игнорироваться.If both ViewXml and BaseViewId are given then the ViewXml will be used and the ad-hoc parameters will be ignored. строкаstring
WebPartId Идентификатор веб-части представления списка, отображающей это представление.The id of the list view web part that is showing this view. строкаstring

Заголовки запросовRequest headers

ЗаголовокHeader ЗначениеValue
ПринятьAccept application/json;odata=nometadataapplication/json;odata=nometadata
Content-TypeContent-Type application/json;odata=nometadataapplication/json;odata=nometadata

Текст запросаRequest body

{
    "parameters": {
        "AddRequiredFields": "true",
        "DatesInUtc": "true",
        "RenderOptions": 17
    }
}
СвойствоProperty ОписаниеDescription ТипType ПримерExample
AddRequiredFields Указывает, должны ли быть возвращены требуемые поляSpecifies if required fields should be returned or not логическийbool true
AllowMultipleValueFilterForTaxonomyFields Указывает, допустима ли фильтрация по нескольким значениям для полей таксономииSpecifies if multi value filtering is allowed for taxonomy fields or not логическийbool true
DatesInUtc Указывает, возвращается ли поле даты и времени в формате UTC или по местному часовому поясу.Specifies if we return DateTime field in UTC or local time. логическийbool true
ExpandGroups Указывает, должна ли быть группировка развернута или нет.Specifies if the grouping should be expanded or not. логическийbool true
FirstGroupOnly Указывает, только ли первая группа должна быть возвращена (независимо от схемы представления).Specifies if only the first group should be returned or not (regardless of view schema). логическийbool true
FolderServerRelativeUrl Задает URL-адрес для папки, из которой требуется возвратить элементы.Specifies the url to the folder from which to return items. строкаstring /sites/team-a/lists/Orders/Europe
ImageFieldsToTryRewriteToCdnUrls Разделенный запятыми список имен полей, значения которых следует переписать в URL-адреса CDNComma-separated list of field names whose values should be rewritten to CDN URLs строкаstring ArticleImage,SecondaryImage
OverrideViewXml Указывает переопределение XML в сочетании с представлением CAML.Specifies the override XML to be combined with the View CAML. Применяется только к части Query/Where представления CAML.Applies only to the Query/Where part of the View CAML. строкаstring <Query><Where><Gt><FieldRef Name=\"OrderCount\" /><Value Type=\"Number\">3</Value></Gt></Where></Query>
Paging Задает сведения о разбиении на страницы.Specifies the paging information. строкаstring
RenderOptions Задает тип возвращаемых выходных данных.Specifies the type of output to return. SPRenderListDataOptionsSPRenderListDataOptions См. возможные значения в следующем разделе.See the next section for possible values. Можно указать несколько значений, добавив их значения вместеYou can specify multiple values by adding their values together
ReplaceGroup Указывает, нужно ли заменить группировку, чтобы учесть регулирование GroupBy.Specifies if the grouping should be replaced or not to deal with GroupBy throttling. логическийbool true
ViewXml Задает XML представления CAML.Specifies the CAML view XML. строкаstring
SPRenderListDataOptionsSPRenderListDataOptions
МеткаLabel ОписаниеDescription ЗначениеValue
None Возвращает стандартные выходные данныеReturn default output 0
ContextInfo Возвращает сведения о контексте спискаReturn list context information 1
ListData Возвращает данные списка (то же, что None)Return list data (same as None) 2
ListSchema Возвращает схему спискаReturn list schema 4
MenuView Возвращает HTML для меню спискаReturn HTML for the list menu 8
ListContentType Возвращает сведения о типах контента списка.Returns information about list content types. Должен применяться в сочетании с флажкомContextInfoMust be combined with the ContextInfo flag 16
FileSystemItemId Возвращаемый список будет по возможности содержать поле FileSystemItemId для каждого элемента.The returned list will have a FileSystemItemId field on each item if possible. Должен применяться в сочетании с флажкомListDataMust be combined with the ListData flag 32
ClientFormSchema Возвращает схему формы клиента, чтобы добавлять и изменять элементы.Returns the client form schema to add and edit items. 64
QuickLaunch Возвращает узлы навигации быстрого запуска.Returns QuickLaunch navigation nodes. 128
Spotlight Возвращает данные об отображении полезных сведений.Returns Spotlight rendering information. 256
Visualization Возвращает сведения об отображении визуализации.Returns Visualization rendering information. 512
ViewMetadata Возвращает XML представления и другие сведения о текущем представлении.Returns view XML and other information about the current view. 1024
DisableAutoHyperlink Предотвращает срабатывание функции AutoHyperlink на текстовые поля в этом запросе.Prevents AutoHyperlink from being run on text fields in this query. 2048
EnableMediaTAUrls Позволяет выполнять URL-адресацию для служб мультимедиа TA, например .thumbnailUrl, .videoManifestUrl, .pdfConversionUrls.Enables URLs pointing to Media TA service, such as .thumbnailUrl, .videoManifestUrl, .pdfConversionUrls. 4096
ParentInfo Возвращает сведения о родительской папке.Returns parent folder information. 8192
PageContextInfo Возвращает сведения о контексте страницы для текущего отображаемого списка.Returns page context info for the current list being rendered. 16384
ClientSideComponentManifest Возвращает сведения манифеста клиентского компонента, связанного со списком.Return client-side component manifest information associated with the list. Зарезервировано для последующего использования.Reserved for future use 32768

ПримерыExamples

Извлечение элемента с определенным идентификаторомRetrieve item with specific ID

POST https://contoso.sharepoint.com/sites/team-a/_api/web/GetList(@listUrl)/RenderListDataAsStream?@listUrl=%27%2Fsites%2Fteam-a%2Flists%2FList%27&FilterField1=ID&FilterValue1=1
accept: application/json;odata=nometadata

Сортировка элементов по убыванию по идентификаторамSort items descending by ID

POST https://contoso.sharepoint.com/sites/team-a/_api/web/GetList(@listUrl)/RenderListDataAsStream?@listUrl=%27%2Fsites%2Fteam-a%2Flists%2FList%27&SortField=ID&SortDir=Desc
accept: application/json;odata=nometadata

Получение элементов из указанной папкиRetrieve items from the specified folder

POST https://contoso.sharepoint.com/sites/team-a/_api/web/GetList(@listUrl)/RenderListDataAsStream?@listUrl=%27%2Fsites%2Fteam-a%2Flists%2FOrders%27
accept: application/json;odata=nometadata
content-type: application/json;odata=nometadata

{
    "parameters": {
        "FolderServerRelativeUrl": "/sites/team-a/lists/Orders/Europe"
    }
}

Получение схемы спискаRetrieve list schema

POST https://contoso.sharepoint.com/sites/team-a/_api/web/GetList(@listUrl)/RenderListDataAsStream?@listUrl=%27%2Fsites%2Fteam-a%2Flists%2FList%27
accept: application/json;odata=nometadata
content-type: application/json;odata=nometadata

{
    "parameters": {
        "RenderOptions": 4
    }
}

Получение сведений о типах контента спискаRetrieve information about list content types

POST https://contoso.sharepoint.com/sites/team-a/_api/web/GetList(@listUrl)/RenderListDataAsStream?@listUrl=%27%2Fsites%2Fteam-a%2Flists%2FList%27
accept: application/json;odata=nometadata
content-type: application/json;odata=nometadata

{
    "parameters": {
        "RenderOptions": 17
    }
}

Создание элемента спискаCreate list item

Ниже показано, как создать элемент списка.The following example shows how to create a list item.

Примечание

[!Примечание] Для выполнения этой операции вам необходимо знать свойство ListItemEntityTypeFullName списка и передать его как значение type в тексте запроса HTTP.To do this operation, you must know the ListItemEntityTypeFullName property of the list and pass that as the value of type in the HTTP request body.

url: http://site url/_api/web/lists/GetByTitle('Test')/items
method: POST
body: { '__metadata': { 'type': 'SP.Data.TestListItem' }, 'Title': 'Test'}
headers:
    Authorization: "Bearer " + accessToken
     X-RequestDigest: form digest value
    accept: "application/json;odata=verbose"
    content-type: "application/json;odata=verbose"
    content-length:length of post body

Создание элемента списка в папкеCreate list item in a folder

В следующем примере показано, как создать элемент списка в папке.The following example shows how to create a list item.

POST /_api/web/lists/GetByTitle('Test')/AddValidateUpdateItemUsingPath

Параметры URIURI Parameters

НетNone

Заголовки запросовRequest headers

ЗаголовокHeader ЗначениеValue
ПринятьAccept application/json;odata=nometadataapplication/json;odata=nometadata
Content-TypeContent-Type application/json;odata=nometadataapplication/json;odata=nometadata
x-requestdigestx-requestdigest Подходящий дайджест для текущего сайтаThe appropriate digest for current site

Тело запросаRequest body

{
    "listItemCreateInfo": {
        "FolderPath":  { "DecodedUrl": "https://contoso.sharepoint.com/lists/Test/Folder/SubFolder" },
        "UnderlyingObjectType": 0
    },
    "formValues": [
        {
            "FieldName": "Title",
            "FieldValue": "Item"
        }
    ],
    "bNewDocumentUpdate": false
}
СвойствоProperty ОписаниеDescription
listItemCreateInfolistItemCreateInfo Информация о списке и папке, где необходимо создать элементInformation about the list and folder where the item should be created
listItemCreateInfo.FolderPath.DecodedUrllistItemCreateInfo.FolderPath.DecodedUrl Абсолютный URL-адрес папки, где необходимо создать элементAbsolute URL of the folder where the item should be created
listItemCreateInfo.UnderlyingObjectTypelistItemCreateInfo.UnderlyingObjectType Тип элемента, который необходимо создать.Type of item to create. Дополнительные сведения см. в разделе https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.client.filesystemobjecttype(v=office.14).aspx. https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.client.filesystemobjecttype(v=office.14).aspxFor more information see https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.client.filesystemobjecttype(v=office.14).aspx
formValuesformValues Массив имен полей и значений, которые необходимо присвоить новому элементуArray of field names and values to set on the newly created item
bNewDocumentUpdatebNewDocumentUpdate Установите значение false, чтобы создать элемент спискаSet to false to create a list item

ОтветыResponses

ИмяName ТипType ОписаниеDescription
200 OK200 OK логическийBoolean УспешноSuccess
{
  "value": [
    {
      "ErrorMessage": null,
      "FieldName": "Title",
      "FieldValue": "Item",
      "HasException": false,
      "ItemId": 0
    },
    {
      "ErrorMessage": null,
      "FieldName": "Id",
      "FieldValue": "1",
      "HasException": false,
      "ItemId": 0
    }
  ]
}

Свойство value содержит список свойств, заданных при создании элемента списка.The value property contains the list of properties that have been set when creating the list item.

Обновление элемента спискаUpdate list item

Ниже показано, как обновить элемент списка.The following example shows how to update a list item.

Примечание

[!Примечание] Для выполнения этой операции вам необходимо знать свойство ListItemEntityTypeFullName списка и передать его как значение type в тексте запроса HTTP.To do this operation, you must know the ListItemEntityTypeFullName property of the list and pass that as the value of type in the HTTP request body.

url: http://site url/_api/web/lists/GetByTitle('Test')/items(item id)
method: POST
body: { '__metadata': { 'type': 'SP.Data.TestListItem' }, 'Title': 'TestUpdated'}
headers:
    Authorization: "Bearer " + accessToken
     X-RequestDigest: form digest value
    "IF-MATCH": etag or "*"
    "X-HTTP-Method":"MERGE",
    accept: "application/json;odata=verbose"
    content-type: "application/json;odata=verbose"
    content-length:length of post body

Удаление элемента спискаDelete list item

Ниже показано, как удалить элемент списка.The following example shows how to delete a list item.

url: http://site url/_api/web/lists/GetByTitle('Test')/items(item id)
method: POST
headers:
    Authorization: "Bearer " + accessToken
     X-RequestDigest: form digest value
    "IF-MATCH": etag or "*"
    "X-HTTP-Method":"DELETE"


Использование значений ETag для определения версий документов и элементов списковUsing ETag values to determine document and list item versioning

Служба SharePoint REST, работающая по стандарту OData, использует значения HTML ETag для управления версиями списков SharePoint и их элементов.The SharePoint REST service, which follows the OData standard, uses HTML ETags for concurrency control of SharePoint lists and list items. Чтобы проверить версию элемента при выполнении запроса PUT, MERGE или DELETE, укажите значение ETag в заголовке HTTP-запроса If-Match.To check on an item's version when you perform a PUT, MERGE, or DELETE request, specify an ETag in the If-Match HTTP request header.

Если ETag, который вы указываете в вашем запросе, не соответствует ETag документа или элемента списка на сервере, служба REST возвращает исключение 412 с помощью спецификации OData.If the ETag you specify in your request does not match the ETag of the document or list item on the server, the REST service returns a 412 exception, per the OData specification.

  • Чтобы принудительно переписать элемент независимо от версии, задайте ETag значение "*".To force an overwrite of the item regardless of version, set the ETag value to "*".

  • Если не указать ETag, SharePoint переписывает элемент независимо от версии.If you do not specify an ETag, SharePoint overwrites the item regardless of version.

В SharePoint значения ETag применяются только к спискам SharePoint и элементам списков.Within SharePoint, ETags apply only to SharePoint lists and list items.

См. такжеSee also