SharePoint Foundation REST インターフェイス
最終更新日: 2015年3月9日
適用対象: SharePoint Foundation 2010
Microsoft SharePoint Foundation 2010 の新しい REST (Representational State Transfer) インターフェイスは、リレーショナル データ サービスとして、リストおよびライブラリへのアクセスを提供します。すべての RESTful インターフェイスの中核となる概念はリソースです。SharePoint Foundation では、リストとアイテムは、リモート URL によってアドレス指定できる HTTP リソースとして表されます。
RESTful Web サービスの標準の操作セットは、SharePoint Foundation REST インターフェイスの操作で構成されます。読み取り、作成、更新、および削除の各操作は、GET、POST、PUT、および DELETE の各 HTTP 動詞に直接マップされます。このため、クライアントとサーバー間の中間層の必要がなくなります。また、これは、相互運用性に役立ちます。他のプラットフォームからアプリケーションを SharePoint Foundation に簡単に接続できるようになるためです。相互運用性は、新しい SharePoint Foundation REST インターフェイスの利点の 1 つですが、さらに、REST インターフェイスはその基盤となる ADO.NET Data Services と統合することで優れた開発環境も提供します。
REST インターフェイスは、データのクエリを実行するための柔軟性の高い URL 変換を使用します。これにより、SharePoint Foundation リストの情報のフィルター処理、並べ替え、および選択をブラウザーから直接行うことができます。また、JavaScript Object Notation (JSON)、Atom、および AtomPub の各標準のサポートを含め、複数の表現を使用して、SharePoint Foundation リストから情報を取得することもできます。SharePoint Foundation リストの標準的な表現を使用すると、単純な Atom フィード リーダーから、エンドユーザーが Microsoft Excel で大量データを分析できるような高度なクライアントにいたるまで、標準に準拠したクライアントでリスト データを使用できるようになります。SharePoint Foundation REST インターフェイスでは、複数の操作を 1 つの要求にまとめるバッチ処理、HTTP ETags による同時実行制御、大量データ セットのページ処理、SharePoint ドキュメント ライブラリ内のドキュメント ストリームへのアクセスなど、ADO.NET Data Services の高度な機能もサポートされます。
次の表に、REST インターフェイスを実装するサンプルの URL を示します。
URL |
説明 |
|---|---|
http://myserver/_vti_bin/ListData.svc |
REST サービスの URL を入力すると、SharePoint Foundation サイトで使用可能な情報のコレクションを記述する標準の Atom サービス ドキュメントが返されます。 |
http://myserver/_vti_bin/ListData.svc/Projects |
サービスの URL の後に名前を入力すると、すべてのリスト アイテムのエントリ、各アイテムのプロパティ、および Atom リンクとして表されるナビゲーション プロパティを含む標準の Atom フィードとして、SharePoint Foundation のリスト データが XML 形式で返されます。ナビゲーション プロパティは、ルックアップ列によって形成される他の SharePoint Foundation リストとの関係を表します。 |
http://myserver/_vti_bin/ListData.svc/$metadata |
SharePoint Foundation インターフェイスは、Web サイト内のすべてのリストのエンティティ型を記述するエンティティ データ モデルの XML を返します。 |
http://lsspf4719/sites/TestWebs/_vti_bin/listdata.svc/Employees(2) |
ID (2) によって指定されたリスト アイテムを、要求されたアイテムに対応する 1 つのエントリを含む 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 クエリは、SharePoint Foundation のリスト データを XML 形式で操作するための柔軟なメカニズムを提供します。また、REST URL を SharePoint Foundation に送信できるあらゆるアプリケーションでそのリスト データを取得できます。たとえば、REST インターフェイスは、リストの新しい結合機能を使用するため、SharePoint Foundation が、結合機能を実装する ADO.NET Data Services クエリを受信すると、そのクエリはネイティブの CAML (Collaborative Application Markup Language) クエリに変換されます。
関連項目
概念
ADO.NET Data Services を使用して SharePoint Foundation のクエリを実行する