SharePoint 的 BCS REST API 引用
包含用于构建代表性状态传输 (REST) URL 的参考信息,以使用 SharePoint 中的 Business Connectivity Services (BCS) 访问和操作外部数据源。
在 SharePoint 中使用 RESTful API 访问外部数据
SharePoint 提供的 REST 界面使您可以通过特殊构建的 URL 访问大部分 SharePoint 资源。 Business Connectivity Services (BCS) 使用此架构提供对外部数据的访问权限。
您可以通过构造 URL 来访问外部数据,就像访问标准列表项一样。
注意
不提供通过 BDC 直接访问实体的权限。 若要使用外部数据,您必须创建一个外部列表,并使用 REST URL 来访问外部列表中的列表项。
用于外部列表的受支持 HTTP 动词为 GET、 PUT、 POST 和 DELETE。
不同于正常列表,您不能使用 REST 创建外部列表。 您必须通过使用 Visual Studio 2008 创建一个 BDC 模型和一个外部列表来做到这一点。
表 1 中的信息显示了如何构建 RESTful URL 和相应的客户端对象模型调用来访问和操作外部数据源中的数据。
表 1. 用于访问外部数据的 RESTful URL 格式
URL | 说明 | HTTP 方法 |
---|---|---|
http://[sharepointsite]/_api |
任何 REST 请求的基础。 _api 虚拟目录映射到 client.svc 中的调用,其中可以使用客户端对象模型。 |
GET |
http://[sharepointsite]/_api/web/title |
检索当前网页的标题。 |
GET |
http://[sharepointsite]/_api/lists |
检索一个网站上的所有列表。 |
GET |
http://[sharepointsite]/_api/lists/getbytitle('listname') |
检索指定列表上的元数据。 |
GET |
http://[sharepointsite]/_api/lists/getbytitle('listname')/items |
检索一个指定列表中的列表项。 |
GET |
http://[sharepointsite]/_api/lists/getbytitle('listname')?select=Title |
检索一个特定列表的标题。 |
GET |
构造筛选数据的查询字符串
为了限制返回的数据数量,或者使其与用户更加相关,您可以使用表 2 中的筛选操作。
表 2. 筛选数据的运算符
运算符 | 说明 |
---|---|
EQ |
等于 注意:使用 EQ 进行筛选时,筛选条件就会传递到服务器上发生筛选的外部系统中。 |
GT |
大于 注意:使用 GT 运算符时,仅执行客户端筛选。> 例如: web/lists/getByTitle('ListName')/Items?$select=Title&$filter=AverageRating gt 3 返回平均分级超过 3 的所有游戏。 |
注意
若要检索关联部分的列,您必须在查询字符串中使用 $select,将该列显式包含在 URL 中。