REST API 引用和示例

项目
09/29/2016

在 MSDN 上查找有关 SharePoint 2013 代表性状态传输 (REST) 接口的文档。

此页面包含对 SharePoint 2013 开发人员可用的常用 REST 资源的链接。

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

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

观看视频：SharePoint 2013 REST 和 OData 基础知识

提示

SharePoint Online REST 服务支持使用 OData $batch 查询选项，将多个请求组合到对服务的单个调用中。有关详细信息和代码示例链接，请参阅使用 REST API 发出批处理请求。内部部署 SharePoint 尚不支持此选项。

SharePoint 2013 REST 参考

备注

以下部分链接指向相应的 JavaScript 对象的文档，该对象在页面底部显示 REST 终结点。

REST 核心端点

资源	说明
SP。ChangeCollection 对象 (sp.js)	表示 SP.Change 对象的集合。
SP。EventReceiverDefinitionCollection 对象 (sp.js)	表示 EventReceiverDefinition 对象的集合，该类对象用于枚举 Microsoft SharePoint Foundation 对象的已注册事件接收器列表。
SP。EventReceiverDefinition 对象 (sp.js)
SP。FeatureCollection 对象 (sp.js)	表示 SP.Feature 对象的集合。
SP。功能对象 (sp.js)	表示一项已激活功能。
SP。RecycleBinItemCollection 对象 (sp.js)	表示 SP.RecycleBinItem 对象的集合。
SP。RecycleBinItem 对象 (sp.js)	表示网站或网站集的回收站中的回收站项目。
SP。RegionalSettings 对象 (sp.js)	表示在运行 Microsoft SharePoint Foundation 的服务器上使用的区域设置。
SP。网站对象 (sp.js)	表示 Web 应用程序中的网站集合，包括首要网站及其所有子网站。
SP。TimeZoneCollection 对象 (sp.js)
SP。时区对象 (sp.js)
Web	表示 SharePoint 网站。
SP。WebTemplateCollection 对象 (sp.js)	指定网站模板的集合。
SP。WebTemplate 对象 (sp.js)	指定用于实例化网站的网站定义或网站模板。

与 REST 列表相关的端点

资源	说明
ListCollection	表示 List 资源的集合。
List	表示 SharePoint 网站上的列表。
ListItemCollection	表示 ListItem 资源的集合。
ListItem	表示列表中的项或行。
SP。ContentTypeCollection 对象 (sp.js)	表示网站或列表内容类型的集合。
SP。ContentType 对象 (sp.js)	表示网站、列表或内容类型。
FieldCollection	表示 Field 资源的集合。
Field	表示 Microsoft SharePoint Foundation 网站列表中的字段。
SP。FieldLinkCollection 对象 (sp.js)	表示 SP.FieldLink 对象的集合，这些对象是内容类型中引用的列或字段。
SP。FieldLink 对象 (sp.js)	指定内容类型对字段或字段定义的引用。
SP。FormCollection 对象 (sp.js)	表示列表的 SP.Form 对象的集合。
SP。窗体对象 (sp.js)	提供单个列表项的显示和编辑界面的表单。
SP.InformationRightsManagementSettings 对象 (sp.js)
SP。ListTemplateCollection 对象 (sp.js)	表示 SP.ListTemplate 对象的集合。
SP。ListTemplate 对象 (sp.js)	指定列表模板。
SP。RelatedFieldCollection 对象 (sp.js)	表示 SP.RelatedField 对象的集合，这些对象存储关系查阅字段的属性。
SP。RelatedField 对象 (sp.js)	指定与查阅字段的关系。
ViewCollection	表示 View 资源的集合。
View	指定列表视图。
ViewFieldCollection	表示列表视图中的字段集合。

文件和文件夹的 REST 终结点

资源	说明
FileCollection	表示 File 资源的集合。
File	表示 SharePoint 网站中的文件，该文件可以是 Web 部件页面、文档库中的项目或文件夹中的文件。
FileVersionCollection	表示 FileVersion 资源的集合。
FileVersion	表示 File 资源的版本。
FolderCollection	表示 Folder 资源的集合。
Folder	表示 SharePoint 网站上的文件夹。

用户和组的 REST 终结点

资源	说明
GroupCollection	表示 Group 资源的集合。
Group	表示 Microsoft SharePoint Foundation 网站上的一个组。
RoleAssignmentCollection	表示 RoleAssignment 资源的集合，该集合定义安全对象的所有角色分配。
RoleAssignment	定义网站、列表或列表项上的用户或组的安全对象角色分配。
RoleDefinitionCollection	表示 RoleDefinition 资源的集合，该集合定义可在网站中使用的角色定义。
RoleDefinition	定义单个角色定义，包括名称、说明和权限集。
RoleDefinitionBindingCollection	定义绑定到角色分配对象的角色定义。
UserCollection	表示 User 资源的集合。
User	表示 Microsoft SharePoint Foundation 中的用户。
UserCustomActionCollection	表示 UserCustomAction 资源的集合。
UserCustomAction	表示与 SharePoint 列表、网站或子网站关联的自定义操作。

REST 复杂类型

资源	说明
AppLicense	表示用于指定 SharePoint 外接程序的指定用户的应用程序许可证。
AppLicenseCollection
AppPrincipalConfiguration	与应用程序主体相关的配置。
AppPrincipalCredentialReference	表示对应用程序主体凭据的引用。
BasePermissions	表示角色定义的基本权限。
CamlQuery	指定对列表或联接列表的协作应用程序标记语言 (CAML) 查询。
ChangeLogItemQuery	表示 GetListItemChangesSinceToken 方法的输入参数。
ChangeQuery	定义对更改日志执行的查询。
ChangeToken	表示某项更改在更改日志中的唯一顺序位置。
ContentTypeCreationInformation	指定将用作参数来初始化新内容类型的属性。
ContentTypeId	表示内容类型的内容类型标识符 (ID)。
ContextWebInformation	网站的上下文信息。
DocumentLibraryInformation	表示文档库的相关信息。
EventReceiverDefinitionCreationInformation	指定事件接收器的创建信息。
ExternalAppPrincipalCreationParameters	表示封装了用于创建新的外部应用程序主体的所有参数的对象。
FieldCalculatedErrorValue	在字段的值存在计算错误，例如被零除或溢出时，表示列表项的计算字段的值。
FieldCreationInformation	表示在创建字段时可以设置的属性。
FieldGeolocationValue	表示用于地理位置字段的海拔、纬度、经度和度量值。
FieldLookupValue	指定列表项内某字段的查阅值。
FieldRatingScaleQuestionAnswer	表示列表项的评估范围字段内的特定子问题和答案。
FieldUrlValue	指定 FieldURL 的超链接和描述值。
FieldUserValue	表示列表项的用户字段的值。
FileCreationInformation	表示在使用 FileCollection.Add 方法创建文件时可以设置的属性。
GroupCreationInformation	用于加快跨网站组的创建的对象。
KeyValue	表示键值对目录。
Language	表示在 Microsoft SharePoint Foundation 上下文中使用的自然语言。
ListDataSource	表示与外部数据源连接关联的信息。
ListDataValidationExceptionValue	当列表字段或列表项的数据验证失败时引发的异常。
ListDataValidationFailure	描述在插入或更新列表项时出现的特定验证失败情况。
ListItemCollectionPosition	指定获取列表视图的下一页数据所需的信息。
ListItemCreationInformation	指定新列表项的属性。
ListItemFormUpdateValue	表示列表项字段的属性及其值。
MenuNode	表示导航层次结构中的导航节点。导航层次结构是导航节点的树结构。
MenuState	表示默认 SiteMapProvider ("SPSiteMapProvider") 的菜单状态，其中转储从网站的根节点开始，深度为 10 层。
NavigationNodeCreationInformation	描述要创建的新导航节点。
RelatedItem
RenderListDataParameters	表示用于列表数据表示为 JavaScript 对象表示法 (JSON) 字符串的参数。
RoleDefinitionCreationInformation	包含用作参数以初始化角色定义的属性。
SimpleDataRow	表示数据表中的行。
SimpleDataTable	表示数据表。
TimeZoneInformation	表示有关时区的信息。
UpgradeInfo	表示网站集升级信息。
UsageInfo	提供用于访问网站集使用情况信息的字段。
UserCreationInformation	用于邀请用户的参数。
UserIdInfo	表示标识提供程序的唯一标识符信息。
ViewCreationInformation	指定用于创建新列表视图的属性。
WebCreationInformation	指定新网站的属性。
WebInfoCreationInformation	表示关于网站创建的元数据。
WebRequestInfo	表示从调用方进行出站 Web 请求所需的数据。
WebResponseInfo	包含第三方服务响应的副本。
XmlSchemaFieldCreationInformation	表示在创建字段时可以设置的属性。

SharePoint 2013 REST 概述

资源	说明
开始使用 SharePoint 2013 REST 服务	了解使用 SharePoint 2013 REST 服务根据 REST 和 OData Web 协议标准访问和更新 SharePoint 数据的基础知识。
使用 SharePoint 2013 REST 终结点完成基本操作	了解如何使用 SharePoint 2013 REST 接口执行基本 CRUD 操作。
SharePoint Search REST API 概述	使用 SharePoint Server 2013 中的搜索 REST 服务以及任何支持 REST Web 请求的技术向客户端和移动应用程序添加搜索功能。
用户配置文件 REST API 引用	了解有关 SharePoint 2013 REST 终结点（针对用户 PeopleManager）、ProfileLoader、UserProfile 及相关资源的信息。
SharePoint 2013 的好友动态订阅源 REST API 引用	了解订阅源相关任务的 SharePoint 2013 REST 终结点。
关注好友及 SharePoint 2013 的内容 REST API 引用	了解下列人员和内容的 SharePoint 2013 REST 终结点。

SharePoint 2013 REST 代码示例

资源	说明
SharePoint 2013：使用 REST 的 Hello World 远程应用程序	了解如何创建"hello world"提供商托管的基本 SharePoint 外接程序，以便使用 SharePoint REST 接口从远程 Web 应用程序读取有关 SharePoint 2013 网站的信息。
SharePoint 2013：从 SharePoint 相关应用程序使用搜索 REST 服务	了解如何从 SharePoint 2013 中的搜索功能中将搜索查询提交到 SharePoint 外接程序。
SharePoint 2013：生成 REST 查询并使用 REST 遍历网站	了解如何使用 SharePoint REST API 遍历 SharePoint 2013 网站，并创建一个生成查询的应用程序，以便对 REST 终结点上公开的基本 SharePoint 实体执行基本数据操作。
SharePoint 2013：在应用程序中使用 REST 执行基本的数据访问操作	了解如何使用 SharePoint REST API 对 SharePoint 2013 列表和列表项执行基本的数据访问操作。
SharePoint 2013：使用 REST 对文件和文件夹执行基本的数据操作	使用 REST 和 SharePointJavaScript 跨域库对文档库和文件执行基本操作的代码示例。
SharePoint 2013：在远程应用程序中进行仅应用程序策略类型调用 (REST)	了解如何将 AllowAppOnlyPolicy 属性与 REST 和 OAuth 结合使用以回调到 SharePoint 2013。
SharePoint 2013：使用 REST 访问外部列表	了解如何创建将使用 RESTful URL 来查询和操作外部列表中的数据的 SharePoint 外接程序。
SharePoint 2013：使用部件版式控制和跨域库 (REST)	了解如何包括托管部件版式控制并使用 SharePoint 2013 中的跨域库和 REST 从主机 Web 检索信息的远程网页。
SharePoint 2013：使用跨域库获取列表项 (REST)	了解如何使用 SharePoint 外接程序中的跨域库读取应用程序 Web 中托管的列表中的项目。
SharePoint 2013：使用跨域库获取主机 Web 标题 (REST)	了解如何使用 SharePoint 2013 中的跨域库读取主机 Web 的 title 属性。
使用 REST 接口设置列表的自定义权限	了解如何使用 REST 接口和 SharePoint 定义自定义和细化 JavaScript 列表的权限。

REST API 引用和示例

SharePoint 2013 REST 参考

SharePoint 2013 REST 概述

SharePoint 2013 REST 代码示例

其他资源

其他资源