SharePoint BCS REST API リファレンス
Representation State Transfer (REST) URL を構築して、SharePointの Business Connectivity Services (BCS) を使用して外部データ ソースに対するアクセスと操作を行うための参照情報を示します。
SharePoint で外部データへアクセスするための REST 対応 API の使用
SharePoint によって提供される REST インターフェイスを使用すれば、特別に構築された URL を介して大部分の SharePoint リソースにアクセスできます。 Business Connectivity Services (BCS) では、このアーキテクチャを使用して外部データにアクセスします。
外部データには、標準的なリスト アイテムにアクセスする場合と同様に URL を作成することでアクセスできます。
注:
BDC を使用してエンティティに直接アクセスすることはできません。 外部データを操作するには、外部リストを作成してから、REST URL を使用してその外部リストに含まれるリスト アイテムにアクセスします。
外部リストを操作するためにサポートされている HTTP 動詞は、 GET、 PUT、 POST、および DELETE です。
通常のリストとは異なり、外部リストは REST を使用して作成することはできません。 それを行うには、Visual Studio 2012 を使用して BDC モデルと外部リストを作成します。
表 1 は REST 対応の URL と、それに対応する外部データ ソースからデータへのアクセスや操作をするために呼び出すクライアント オブジェクト モデルの作成方法を示します。
表 1. 外部データ アクセスのための REST 対応 URL の形式
| URL | 説明 | HTTP メソッド |
|---|---|---|
http://[sharepointsite]/_api |
すべての REST リクエストの基礎です。 _api 仮想ディレクトリは、クライアント オブジェクト モデルが使用される client.svc への呼び出しにマッピングされます。 |
GET |
http://[sharepointsite]/_api/web/title |
現在の Web のタイトルを取得します。 |
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 にその列を明示的に含める必要があります。