SharePoint REST サービス

  • 3 分

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

SharePoint REST サービスのしくみ

SharePoint には、REST を使用して SharePoint サイトとリモートで操作できる機能が追加されています。 これで、標準の REST 機能をサポートする任意のテクノロジを使用して、SharePoint オブジェクトを直接操作できます。

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

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

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

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

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

次の表は、HTTP 要求の概要を示しています。

アクション HTTP 要求 注意すべきこと
リソースの読み取り GET 返されるデータ形式を変更する必要がある場合があります。
リソースの作成または更新 POST POSTを使用して、リストやサイトなどのエンティティを作成します。 SharePoint REST サービスは、コレクションを表すエンドポイントへのオブジェクト定義を含む POST コマンドの送信をサポートします。 POST 操作では、必要のないプロパティは既定値に設定されます。 POST 操作の一部として読み取り専用プロパティを設定しようとすると、サービスは例外を返します。
リソースの作成または挿入 PUT PUT および MERGE 操作を使用して、既存の SharePoint オブジェクトを更新します。 オブジェクト プロパティ セットの操作を表すサービス エンドポイントは、PUT 要求および MERGE 要求をサポートします。 MERGE 要求では、設定プロパティはオプションです。明示的に設定しないプロパティは、現在のプロパティを保持します。 PUT 要求では、オブジェクトの更新ですべての必須プロパティを指定しない場合、REST サービスは例外を返します。 明示的に指定しないオプションのプロパティは、既定のプロパティに設定されます。
リソースの削除 DELETE 特定のエンドポイント URL に対して HTTP DELETE コマンドを使用し、そのエンドポイントで表される SharePoint オブジェクトを削除します。 リスト、ファイル、リスト項目など、再利用できるオブジェクトを使用できるため、再利用操作を実行できます。

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

SharePoint では REST API を使用します。 API は、2 つのアプリケーションが相互に情報をやりとりできるようにするソフトウェアの仲介役です。 スマートフォンのアプリを使用して天気を確認するたびに、API を使用していることになります。

SharePoint REST サービス エンドポイントを作成するには、次の手順に従います。

  1. REST サービス参照から開始します。

    https://{site_url}/_api

  2. 次に示すの例のような、適切なエントリ ポイントを指定します。

    https://{site_url}/_api/web

    例: https://contoso.sharepoint.com/_api/web

  3. 次の例に示すように、クライアント オブジェクト モデルのメソッドに対応するエンドポイントのパラメーターの指定など、エントリー ポイントからアクセスしたい特定のリソースに移動します。

    https://{site_url}/_api/web/lists/getbytitle('list_name')

    例: https://contoso.sharepoint.com/_api/Lists/getbytitle('TestList')