列表和列表项 REST API 引用

项目
09/29/2016

了解 REST API 中的列表、列表项、视图以及其他列表相关的资源和终结点。

上次修改时间：2015年9月17日

适用范围：apps for SharePoint | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013

关于本文中的请求示例

本文中的请求示例假设您正在使用跨域库 (SP.RequestExecutor.js) 发出跨域请求，因此它们在终结点 URI 中使用 SP.AppContextSite。有关详细信息，请参阅使用跨域库从外接程序访问 SharePoint 2013 数据。

使用请求示例之前，请执行下列操作：

更改 <应用程序 Web URL>、<主机 Web URL> 和其他占位符数据，例如 SharePoint 条目的任何 ID、名称或路径。
如果您未使用跨域库，请包括用于在所有 POST 请求中发送表单摘要值的 X-RequestDigest 标头，以及在请求正文中发送数据的 POST 请求的 content-length 标头。
如果您未发出跨域请求，请从终结点 URI 中删除 SP.AppContextSite(@target) 和 ?@target='<host web url>'。
如果您使用 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 语法

以可视化方式浏览SharePoint 2013 列表和列表项 REST 语法。

浏览其他 SharePoint REST 语法图表：

文件和文件夹 | 用户和组

下载所有 SharePoint REST 语法图表的组合 PDF。

备注

查询特定列表的项时，OData $skip 查询选项不起作用，查询列表终结点时则起作用。

List 资源

表示一个 SharePoint 列表。一个列表是一种 SP.SecurableObject。

终结点 URI | 属性 | 方法 | OData 表示

终结点 URI

http://<网站 URL>/web/lists(guid'<列表 ID>')

支持的 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
});

或者您可以使用 ListCollection 资源中的 GetByTitle 方法根据标题获取列表。示例：…/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 方法删除文件。

列表属性

若要获取属性，请向属性终结点发送 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 值。有关模板类型值，请参阅 .NET 客户端对象模型引用中的 ListTemplateType。
BaseType	Int32	R	是	获取列表的基本类型。表示 SP.BaseType 值：Generic List = 0；Document Library = 1；Discussion Board = 3；Survey = 4；Issue = 5。
BrowserFileHandling	Int32	R	否	获取一个值，该值指定 Web 应用程序 BrowserFileHandling 属性在列表级别的覆盖。表示 SP.BrowserFileHandling 值：Permissive = 0；Strict = 1。
ContentTypes	SP.ContentTypeCollection	R	否	获取与列表关联的内容类型。
ContentTypesEnabled	Boolean	RW	是	获取或设置一个值，该值指定是否对列表启用内容类型。
Created	DateTime	R	是	获取指定该列表创建时间的值。
DataSource	SP.ListDataSource	R	否	获取与列表关联的数据源，如果列表不是虚拟列表，则为 null。如果 false 属性为 HasExternalDataSource，则返回 null。
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。如果基本类型为 DocumentLibrary，则返回相对于服务器的 URL，否则返回 null。
DraftVersionVisibility	Int32	RW	是	获取或设置一个值，该值指定查看列表内的次要版本和草稿所需的最小权限。表示 SP.DraftVisibilityType 值：Reader = 0，Author = 1，Approver = 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	否
域	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	否	获取一个值，该值指示列表是否被指定为用户上载到其 Wiki 页面的图像或其他文件的默认资源位置。
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。
标题	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(<项目 id>)
参数	类型：Int32 列表项的 ID。
HTTP method	GET
响应	类型：SP.ListItem 特定 ID 的列表项。

请求示例

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
});

或者您可以将列表项 ID 传递到 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 包含在指定更改之后对列表项所做更改的 XML 表示的 Stream。

请求示例

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
});

请参阅使用 REST 服务同步 SharePoint 项获取如何指定筛选查询的示例。

响应示例

<?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="https://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="https://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="https://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="https://schemas.microsoft.com/sharepoint/v3" StaticName="File_x0020_Type" FromBaseType="TRUE" ColName="nvarchar2"/>
        <Field ID="{fc2e188e-ba91-48c9-9dd3-16431afddd50}" Name="WorkAddress" SourceID="https://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="https://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="https://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="https://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('<视图 ID>')
参数	类型：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 资源上的视图 ID。示例：…/_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 = Display; 2 = Edit; 3 = New。
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 方法

保留创建幂等列表项的列表项 ID。

终结点	/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 表示

以下示例表示 JSON 格式的 List 资源。

    {"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 请求示例：根据 ID 获取一个列表

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 方法

获取用户上载到其 Wiki 页面的图像或其他文件的默认资源位置的列表。

终结点	/ensuresiteassetslibrary
参数	无
HTTP method	POST
响应	类型：SP.List Wiki 网页资产的默认位置列表。

请求示例

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 方法

获取 Wiki 页面默认位置的列表。

终结点	/ensuresitepageslibrary
参数	无
HTTP method	POST
响应	类型：SP.List Wiki 网页的默认位置列表。

请求示例

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.List 带有指定标识符的列表。

请求示例

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
});

或者您可以将列表 ID 传递到 ListCollection 资源。示例：…/web/lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')。

GetByTitle 方法

从集合中返回具有指定标题的列表。

终结点	/getbytitle
参数	类型：String 列表标题。
HTTP method	GET
响应	类型：SP.List 带有指定标题的列表。

请求示例

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 表示

以下示例表示 JSON 格式的 ListCollection 资源。

    {"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'<列表 ID>')/items(<项目 ID>)
http://<网站 URL>/web/lists/getbytitle('<列表标题>')/items(<项目 ID>)

支持的 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 属性，并在 HTTP 请求正文中将其传递为 type 的值。

示例

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 属性，并在 HTTP 请求正文中将其传递为 type 的值。

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	是	获取当前用户的有效基本权限，因为它们应该显示在 UI 中。
FieldValuesAsHtml	SP.FieldStringValues	R	否	以 HTML 形式获取列表项的值。
FieldValuesAsText	SP.FieldStringValues	R	否	获取列表项的字段值作为字符串值的集合。
FieldValuesForEdit	SP.FieldStringValues	R	否	获取要显示在编辑表单中的格式值。
文件	SP.File	R	否	从文档库中获取由该项表示的文件。
FileSystemObjectType	Int32	R	是	获取一个值，该值指定列表项是一个文件还是一个列表文件夹。表示 SP.FileSystemObjectType 值：Invalid = -1；File = 0；Folder = 1；Web = 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，否则为 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 表示

以下示例表示 JSON 格式的 ListItem 资源。该资源也返回其字段值。

    {"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'<列表 ID>')/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 属性，并在 HTTP 请求正文中将其传递为 type 的值。

示例

ListItemCollection 方法

GetById

GetById 方法

返回具有指定列表项标识符的列表项。

终结点	/getbyid(<项目 id>)
参数	类型：Int32 列表项的 ID。
HTTP method	GET
响应	类型：SP.ListItem 特定 ID 的列表项。

请求示例

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 资源上的列表项 ID。示例：…/_api/web/lists(guid'a290086b-2d43-4151-add4-893474a930a9')/items(2)

OData 表示

以下示例表示 JSON 格式的 ListItemCollection 资源，该资源返回 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'<列表 ID>')/views('<视图 ID>')

支持的 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
});

或者，您可以使用 ViewCollection 资源中的 GetByTitle 方法，以根据其标题（区分大小写）获取视图。示例：…/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
});

示例

视图属性

若要获取属性，请向属性终结点发送 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	返回资源	说明
聚合	String	RW	是	获取或设置一个值，该值指定定义显示在列表视图中的总计的字段和函数。如果不为空，则 XML 必须符合 [MS-WSSCAML] 中指定的 FieldRefDefinitionAggregation。
AggregationsStatus	String	RW	是	获取或设置一个值，该值指定是否在列表视图中显示总计。
BaseViewId	String	R	是	获取一个值，该值指定列表视图的基础视图标识符。
ContentTypeId	SP.ContentTypeId	RW	是	获取或设置内容类型的标识符，视图与该内容类型关联，以便视图仅适用于此内容类型的文件夹。
DefaultView	Boolean	RW	是	获取或设置一个值，该值指定列表视图是否是默认列表视图。
DefaultViewForContentType	Boolean	RW	是	获取或设置一个值，该值指定列表视图是否是 contentTypeId 指定的内容类型的默认列表视图。
EditorModified	Boolean	RW	是	获取或设置一个值，该值指定列表视图是否是在编辑器中修改的。
Formats	String	RW	是	获取或设置一个值，该值指定列表视图的列和行的格式。如果不为空，则 XML 必须符合 [MS-WSSCAML] 中指定的 ViewFormatDefinitions。
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 必须符合 [MS-WSSCAP] 中指定的 Method。
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	是	获取一个值，该值指定列表视图是否是按线索组织的视图。
标题	String	RW	是	获取或设置一个值，该值指定列表视图的显示名称。
Toolbar	String	RW	是	获取或设置一个值，该值指定列表视图的工具栏。
ToolbarTemplateName	String	R	是	获取一个值，该值指定列表视图中使用的工具栏的模板名称。
ViewData	String	RW	是	获取或设置一个值，该值指定列表视图的视图数据。如果不为空，则 XML 必须符合 [MS-WSSCAML] 中指定的 FieldRefDefinitionViewData。
ViewFields	SP.ViewFieldCollection	R	否	获取一个值，该值指定列表视图中字段的集合。
ViewJoins	String	RW	是	获取或设置一个值，该值指定列表视图中使用的联接。如果不为空，则 XML 必须符合 [MS-WSSCAML] 中指定的 ListJoinsDefinition。
ViewProjectedFields	String	RW	是	获取或设置一个值，该值指定将由列表视图使用的投射字段。如果不为空，则 XML 必须符合 [MS-WSSCAML] 中指定的 ProjectedFieldsDefinitionType。
ViewQuery	String	RW	是	获取或设置一个值，该值指定列表视图使用的查询。如果不为空，则 XML 必须符合 [MS-WSSCAML] 中指定的 CamlQueryRoot。
ViewType	String	R	是	获取一个值，该值指定列表视图的类型。可以是 HTML、网格、日历、重复周期、图表或甘特图。

视图方法

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 表示

以下示例表示 JSON 格式的 View 资源。

    {"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://<网站 URL>/_api/web/lists(guid'<列表 ID>')/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
});

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 方法

获取具有指定 ID 的列表视图。

终结点	/getbyid('<视图 ID>')
参数	类型：String 视图的 ID。
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
});

或者您可以将视图 ID 传递到 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 表示

以下示例表示 JSON 格式的 ViewCollection 资源。

    {"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://<网站 URL>/_api/web/lists(guid'<列表 ID>')/views('<视图 ID>')/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 表示

以下示例表示 JSON 格式的 ViewFieldCollection 资源。

    {"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"]}
    }}

Share via

列表和列表项 REST API 引用

关于本文中的请求示例

浏览 SharePoint 2013 列表和列表项 REST 语法

List 资源

终结点 URI

支持的 HTTP 方法

请求示例

列表属性

List 方法

AddItem 方法

BreakRoleInheritance 方法

DeleteObject 方法

GetChanges 方法

GetItemById 方法

GetItems 方法

GetListItemChangesSinceToken 方法

GetRelatedFields 方法

GetUserEffectivePermissions 方法

GetView 方法

Recycle 方法

RenderListData 方法

RenderListFormData 方法

ReserveListItemId 方法

ResetRoleInheritance 方法

OData 表示

ListCollection 资源

终结点 URI

支持的 HTTP 方法

请求示例

ListCollection 方法

EnsureSiteAssetsLibrary 方法

EnsureSitePagesLibrary 方法

GetById 方法

GetByTitle 方法

OData 表示

ListItem 资源

终结点 URI

支持的 HTTP 方法

请求示例

ListItem 属性

ListItem 方法

BreakRoleInheritance 方法

DeleteObject 方法

GetUserEffectivePermissions 方法

Recycle 方法

ResetRoleInheritance 方法

ValidateUpdateListItem 方法

OData 表示

ListItemCollection 资源

终结点 URI

支持的 HTTP 方法

请求示例

ListItemCollection 方法

GetById 方法

OData 表示

View 资源

终结点 URI

支持的 HTTP 方法

请求示例

视图属性

视图方法

DeleteObject 方法

RenderAsHtml 方法

OData 表示

ViewCollection 资源

终结点 URI

支持的 HTTP 方法

请求示例

ViewCollection 方法

GetById 方法

GetByTitle 方法

OData 表示

ViewFieldCollection 资源

终结点 URI

支持的 HTTP 方法

请求示例

ViewFieldCollection 属性

ViewFieldCollection 方法

AddViewField 方法