SharePoint Foundation REST 接口

上次修改时间: 2015年3月9日

适用范围: SharePoint Foundation 2010

在 SharePoint Online 中提供

Microsoft SharePoint Foundation 2010 中的新 REST (Representational State Transfer) 接口以关系数据服务的形式提供对列表和库的访问权限。任何 REST 接口的核心概念都是资源,在 SharePoint Foundation 中,列表和项目由远程 URL 可解析的 HTTP 资源来表示。

SharePoint Foundation REST 接口中的操作构成了用于 RESTful Web 服务的一组标准操作。读取、创建、更新和删除操作会直接映射到 GET、POST、PUT 和 DELETE HTTP 动词,从而无需在客户端和服务器之间构建中间层,并且允许其他平台上的应用程序轻松连接到 SharePoint Foundation,因此对互操作性而言很有用。互操作性是新 SharePoint Foundation REST 接口的优点之一,REST 接口还通过与它所基于的 ADO.NET Data Services 相集成来提供卓越的开发体验。

REST 接口使用灵活的 URL 转换来查询数据,这使您可以直接通过浏览器来筛选、排序和选择 SharePoint Foundation 列表中的信息。还可以通过多种表示形式从 SharePoint Foundation 列表中检索信息,包括对 JavaScript Object Notation (JSON)、Atom 和 AtomPub 标准的支持。SharePoint Foundation 列表的标准表示形式使列表数据可供符合标准的客户端使用,这些客户端包括简单的 Atom 源阅读器,以及允许最终用户对 Microsoft Excel 中的大量数据进行分析的更高级客户端。SharePoint Foundation REST 接口还支持 ADO.NET Data Services 的高级功能,例如将多个操作批处理为单个请求、通过 HTTP ETag 进行货币控制、对大型数据集进行分页以及访问 SharePoint 文档库中的文档流。

下表显示实现 REST 接口的 URL 示例。

URL

说明

http://myserver/_vti_bin/ListData.svc

键入 REST 服务的 URL 将返回标准 Atom 服务文档,该文档描述 SharePoint Foundation 网站中提供的信息集合。

http://myserver/_vti_bin/ListData.svc/Projects

在服务的 URL 后键入名称会将 XML 格式的 SharePoint Foundation 列表数据返回为标准 Atom 源,其中包含每个列表项的条目和各项的属性,以及表示为 Atom 链接的导航属性。导航属性表示与通过查找列形成的其他 SharePoint Foundation 列表的关系。

http://myserver/_vti_bin/ListData.svc/$metadata

SharePoint Foundation 接口会返回实体数据模型 XML,以描述网站中每个列表的实体类型。

http://lsspf4719/sites/TestWebs/_vti_bin/listdata.svc/Employees(2)

按 ID (2) 将指定列表项返回为 Atom 源,其中包含一个与请求项对应的条目。

http://lsspf4719/sites/TestWebs/_vti_bin/listdata.svc/Employees?$orderby=Name

按名称对 Atom 源进行排序。

http://lsspf4719/sites/TestWebs/_vti_bin/listdata.svc/Employees?$filter=Project/Title eq 'My Project Title'

使用导航属性按相关项目的标题筛选列表。

通过利用 SharePoint Foundation 数据存储的新功能,REST 查询提供了用于处理 XML 格式的 SharePoint Foundation 列表数据的灵活机制,可以向 SharePoint Foundation 发送 REST URL 的任何应用程序都可以检索其列表数据。例如,REST 接口可使用列表的新连接功能,因此当 SharePoint Foundation 收到实现连接功能的 ADO.NET Data Services 查询时,会将该查询转换为本机协作应用程序标记语言 (CAML) 查询

请参阅

概念

使用 ADO.NET 数据服务查询 SharePoint Foundation

列出联接和投影

其他资源

WCF REST Programming Model