SharePoint REST サービスの概要

SharePoint には、既存の SharePoint クライアント オブジェクト モデルと比較できる REST (Representational State Transfer) サービスが含まれます。 開発者は、REST Web 要求をサポートするテクノロジを使用して SharePoint データとリモートで対話できるようになりました。 つまり、開発者は自身の SharePoint アドイン、ソリューション、クライアント アプリケーションから REST Web テクノロジと標準の OData (Open Data Protocol) 構文を使用して、CRUD (作成、読み取り、更新、削除) 操作を実行できるようになりました。

前提条件

このトピックでは、REST と REST 要求の作成方法に基本的に精通しているものとします。

SharePoint REST サービスのしくみ

SharePoint では、REST を使用して、SharePoint サイトをリモートから操作できるようにする機能が追加されました。 これにより、ユーザーのコードは、標準の REST 機能をサポートする技術を使用することで SharePoint オブジェクトと直接やり取りできます。

REST を使用して SharePoint リソースにアクセスするには、目的のクライアント オブジェクト モデル API に対応する OData 標準を使用して、REST 対応の HTTP 要求を作成します。 例:

var items = List.GetByTitle(listname).GetItems();

GET https://{site_url}/_api/lists/getbytitle('{list_name}')/items
Authorization: "Bearer " + accessToken
Accept: "application/json;odata=verbose"

SharePoint の client.svc という Web サービスは HTTP 要求を処理し、Atom または JSON (JavaScript Object Notation) 形式で該当する応答をします。 その後、クライアント アプリケーションは、その応答を解析する必要があります。 次の図は、SharePoint REST アーキテクチャの概要を示しています。

SharePoint REST サービスのアーキテクチャ

クライアント オブジェクト モデルは、その機能と使いやすさのため、.NET Framework、Silverlight (現在は廃止)、または JavaScript (JSOM) を使用した SharePoint との通信の開発において、依然として主要な選択肢となっています。

SharePoint REST サービスでの HTTP コマンドの使用

SharePoint に組み込まれている REST 機能を使用するには、使用するクライアント オブジェクト モデル API に対応する OData 標準を使用して RESTful HTTP 要求を作成します。 client.svc Web サービスは HTTP 要求を処理し、Atom または JSON 形式で該当する応答をします。 その後、クライアント アプリケーションは、その応答を解析する必要があります。

SharePoint REST サービスのエンドポイントは、SharePoint クライアント オブジェクト モデルの型とメンバーに対応しています。 HTTP 要求を使用して、これらの REST エンドポイントを使って、リストやサイトなどの SharePoint エンティティに対して典型的な CRUD 操作を行うことができます。

SharePoint リソースにアクセスするための REST URL の作成

これらの REST エンドポイントの URI は、できる限り API シグネチャの構造に近いものとします。 REST サービスの主なエントリ ポイントは、指定されたコンテキストのサイト コレクションとサイトを表します。

特定のサイト コレクションにアクセスするには、次の構造を使用します。

https://{site_url}/_api/site

特定のサイトにアクセスするには、次の構造を使用します。

https://{site_url}/_api/web

どちらの場合も、server はサーバーの名前、site は特定のサイトの名前 (パス名) を表します。

これを基本形として、ダッシュで区切ったクライアント オブジェクト モデルの API 名を使用して、オブジェクト モデルを「階層化」することで、さらに具体的な REST URI を作成することができます。

この構文は、SocialFeedManager または SocialFollowingManager の REST API には適用されません。 詳細については、以下を参照してください。

• SharePoint ソーシャル フィード REST API リファレンス
• SharePoint でのユーザーやコンテンツのフォローに関する REST API リファレンス

対応するクライアント オブジェクト モデル API のシグネチャから SharePoint REST エンドポイント URI を決定する詳細なガイドラインについては、「SharePoint REST サービス エンドポイント URI を決定する」を参照してください。

SharePoint REST エンドポイントの例

以下の表に、SharePoint データでの作業を開始するための典型的な REST エンドポイント URL の例を示します。 完全修飾の REST URL を作成するには、表に示される URL フラグメントの先頭に http://server/site/_api/ を付けます。 POST コマンドの場合に必要な個所では、指定された SharePoint アイテムを作成するために HTTP 要求の本文で渡す必要のあるサンプル データが表に示されています。 引用符内のアイテムは実際の値に置き換える必要のある変数を表します。

リストを作成するサンプル データ

{
  "__metadata": {
    "type": "SP.List"
  },
  "AllowContentTypes": true,
  "BaseTemplate": 104 ,
  "ContentTypesEnabled": true,
  "Description": "My list description ",
  "Title": "RestTest "
}

リストにアイテムを追加するサンプル データ

{
  "__metadata": {
    "type": "SP.Data.listname.ListItem"
  },
  "Title": "MyItem"
}

上記の JSON では、スペースを省略して listname を SharePoint リストの名前に置き換えます。

バッチ ジョブのサポート

SharePoint Online (およびオンプレミスの SharePoint 2016 以降の) REST サービスは、OData $batch クエリ オプションを使用して、複数の要求を組み合わせて 1 つのサービスへの呼び出しにすることをサポートしています。 詳細とコード サンプルへのリンクについては、「REST API によりバッチ要求を発行する」を参照してください。

OData の技術情報

• WCF によるサービス指向アプリケーションの開発
• Open Data Protocol
• OData Protocol URI の規則
• サービス操作への対応
• OData Protocol の操作
• エラー条件

SharePoint REST サービスのトピック

SharePoint REST サービスの使用の詳細については、下記の参照資料を使用してください。