REST API リファレンスおよびサンプル
ここでは、SharePoint 2013 Representational State Transfer (REST) インターフェイスに関する MSDN のドキュメントを紹介します。
このページには、SharePoint 2013 開発者が利用できる、一般的に使用される REST リソースへのリンクがあります。
適用対象: apps for SharePoint | SharePoint Foundation 2013 | SharePoint Server 2013
この記事の内容
SharePoint 2013 REST リファレンス
SharePoint 2013 REST の概要
SharePoint 2013 REST のコード サンプル
その他の技術情報
ビデオを見る: SharePoint 2013 REST および OData の基本
ヒント
SharePoint Online REST サービスは、OData $batch クエリ オプションを使用して複数の要求を、サービスに対する 1 つの呼び出しに結合できます。詳細とコード サンプルへのリンクについては、「REST API によりバッチ要求を発行する」をご覧ください。このオプションは、オンプレミスの SharePoint ではサポートされていません。
SharePoint 2013 REST リファレンス
注意
次のリンクのいくつかは、対応する JavaScript オブジェクトの資料を開きます。それらの資料のページの下部には REST エンドポイントが表示されています。
REST コア エンドポイント
リソース |
説明 |
|---|---|
SP.Change オブジェクトのコレクションを表します。 |
|
Microsoft SharePoint Foundation オブジェクトの登録されたイベント レシーバーのリストを列挙するのに使用される EventReceiverDefinition オブジェクトのコレクションを表します。 |
|
SP.Feature オブジェクトのコレクションを表します。 |
|
アクティブ化された機能を表します。 |
|
SP.RecycleBinItem オブジェクトのコレクションを表します。 |
|
サイトまたはサイト コレクションのごみ箱内にあるごみ箱アイテムを表します。 |
|
Microsoft SharePoint Foundation を実行しているサーバー上で使用される地域設定を表します。 |
|
トップレベルの Web サイトとそのすべてのサブサイトを含む、Web アプリケーション内のサイトのコレクションを表します。 |
|
SharePoint サイトを表します。 |
|
サイト テンプレートのコレクションを指定します。 |
|
サイトのインスタンス化に使用されるサイト定義またはサイト テンプレートを指定します。 |
リスト関連の REST エンドポイント
リソース |
説明 |
|---|---|
List リソースのコレクションを表します。 |
|
SharePoint Web サイト上のリストを表します。 |
|
ListItem リソースのコレクションを表します。 |
|
リスト内のアイテムまたは行を表します。 |
|
Web サイトまたはリスト コンテンツ タイプのコレクションを表します。 |
|
Web サイト (リスト) のコンテンツ タイプを表します。 |
|
Field リソースのコレクションを表します。 |
|
Microsoft SharePoint Foundation Web サイト上にあるリスト内のフィールドを表します。 |
|
コンテンツ タイプ内の列またはフィールド参照である SP.FieldLink オブジェクトのコレクションを表します。 |
|
コンテンツ タイプのフィールドまたはフィールド定義への参照を指定します。 |
|
リストの SP.Form オブジェクトのコレクションを表します。 |
|
フォームは 1 つのリスト アイテムの表示および編集用インターフェイスを提供します。 |
|
SP.ListTemplate オブジェクトのコレクションを表します。 |
|
リスト テンプレートを指定します。 |
|
リレーションシップ ルックアップ フィールドのプロパティを格納している SP.RelatedField オブジェクトのコレクションを表します。 |
|
ルックアップ フィールドに対するリレーションシップを指定します。 |
|
View リソースのコレクションを表します。 |
|
リスト ビューを指定します。 |
|
リスト ビュー内のフィールドのコレクションを表します。 |
ファイルおよびフォルダーの REST エンドポイント
リソース |
説明 |
|---|---|
File リソースのコレクションを表します。 |
|
SharePoint Web サイト内のファイルを表します。このファイルは、Web パーツ ページ、ドキュメント ライブラリ内のアイテム、またはフォルダー内のファイルのいずれかになります。 |
|
FileVersion リソースのコレクションを表します。 |
|
File リソースのバージョンを表します。 |
|
Folder リソースのコレクションを表します。 |
|
SharePoint Web サイト上のフォルダーを表します。 |
ユーザーおよびグループの REST エンドポイント
リソース |
説明 |
|---|---|
Group リソースのコレクションを表します。 |
|
Microsoft SharePoint Foundation Web サイト上のグループを表します。 |
|
セキュリティ設定が可能なオブジェクトのすべてのロール割り当てを定義する、RoleAssignment リソースのコレクションを表します。 |
|
Web サイト、リスト、またはリスト アイテム上でユーザーまたはグループに対するセキュリティ設定が可能なオブジェクトのロール割り当てを定義します。 |
|
サイト内で使用できるロールを定義する RoleDefinition リソースのコレクションを表します。 |
|
名前、説明、および権利セットを含む 1 つのロール定義を設定します。 |
|
ロール割り当てオブジェクトにバインドされたロール定義を定義します。 |
|
User リソースのコレクションを表します。 |
|
Microsoft SharePoint Foundation 内のユーザーを表します。 |
|
UserCustomAction リソースのコレクションを表します。 |
|
SharePoint リスト、Web サイト、またはサブサイトに関連付けられているカスタム アクションを表します。 |
REST 複合型
リソース |
説明 |
|---|---|
指定された SharePoint アドインの指定されたユーザー用のアプリ ライセンスを表します。 |
|
アプリ プリンシパルに関連付けられている構成。 |
|
アプリ プリンシパルの資格情報への参照を表します。 |
|
ロール定義の基本アクセス許可を表します。 |
|
リストまたは結合リストの CAML (Collaborative Application Markup Language) クエリを指定します。 |
|
GetListItemChangesSinceToken メソッドの入力パラメーターを表します。 |
|
変更ログに対して実行されるクエリを定義します。 |
|
変更ログ内の変更の一意のシーケンシャルな場所を表します。 |
|
新しいコンテンツ タイプを初期化するパラメーターとして使用されるプロパティを指定します。 |
|
コンテンツ タイプのコンテンツ タイプ識別子 (ID) を表します。 |
|
サイトのコンテキスト情報。 |
|
ドキュメント ライブラリに関する情報を表します。 |
|
イベント レシーバーの作成情報を指定します。 |
|
新しい外部アプリ プリンシパルの作成に使用されるすべてのパラメーターをカプセル化するオブジェクトを表します。 |
|
ゼロによる除算、オーバーフローなど、フィールドの値が計算エラーになったときのリスト アイテムの集計フィールドの値を表します。 |
|
フィールドを作成するときに設定できるプロパティを表します。 |
|
地理位置情報フィールドの高度、緯度、経度、および測定値を表します。 |
|
リスト アイテム内のフィールドのルックアップの値を指定します。 |
|
リスト アイテムの段階評価フィールド内にある特定の補足質問および回答を表します。 |
|
FieldURL のハイパーリンクおよび説明の値を指定します。 |
|
リスト アイテムのユーザー フィールドの値を表します。 |
|
FileCollection.Add メソッドを使用してファイルを作成するときに設定できるプロパティを表します。 |
|
クロスサイト グループの作成を容易にするために使用されるオブジェクトです。 |
|
キーと値のペアの辞書を表します。 |
|
Microsoft SharePoint Foundation のコンテキスト内で使用される自然言語を表します。 |
|
外部データ ソースへの接続に関連する情報を表します。 |
|
リスト フィールドまたはリスト アイテムのデータの検証に失敗した場合にスローされる例外です。 |
|
リスト アイテムの挿入または更新時の具体的な検証エラーを記述します。 |
|
リスト ビューでデータの次のページを取得するために必要な情報を指定します。 |
|
新しいリスト アイテムのプロパティを指定します。 |
|
リスト アイテムのフィールドとその値のプロパティを表します。 |
|
ナビゲーション階層内のナビゲーション ノードを表します。 ナビゲーション階層は、ナビゲーション ノードのツリー構造です。 |
|
深さが 10 レベルのサイトのルート ノードでダンプが開始される、既定の SiteMapProvider ("SPSiteMapProvider") のメニュー状態を表します。 |
|
作成される新しいナビゲーション ノードを記述します。 |
|
リスト データを JavaScript Object Notation (JSON) 文字列としてレンダリングする場合に使用するパラメーターを表します。 |
|
ロール定義を初期化するパラメーターとして使用されるプロパティを格納します。 |
|
データ テーブル内の行を表します。 |
|
データ テーブルを表します。 |
|
タイム ゾーンに関する情報を表します。 |
|
サイト コレクションのアップグレード情報を表します。 |
|
サイト コレクションの使用状況に関する情報へのアクセスに使用されるフィールドを提供します。 |
|
ユーザーを招待するためのパラメーターです。 |
|
ID プロバイダーの一意の識別子情報を表します。 |
|
新しいリスト ビューの作成に使用されるプロパティを指定します。 |
|
新しいサイトのプロパティを指定します。 |
|
サイトの作成に関するメタデータを表します。 |
|
送信 Web 要求を行うために必要な呼び出し元からのデータを表します。 |
|
サードパーティ サービスの応答のコピーが含まれます。 |
|
フィールドを作成するときに設定できるプロパティを表します。 |
SharePoint 2013 REST の概要
リソース |
説明 |
|---|---|
SharePoint 2013 REST サービスを使用して SharePoint データへのアクセスおよび更新を行う方法と、REST および OData Web プロトコル標準を使用する方法についての基本事項を説明します。 |
|
SharePoint 2013 REST インターフェイスを使用して基本的な CRUD 操作を実行する方法について説明します。 |
|
SharePoint Server 2013 の検索 REST サービスと、REST Web 要求をサポートするテクノロジを使用してクライアント アプリケーションとモバイル アプリケーションに検索機能を追加します。 |
|
ユーザー UserProfile、PeopleManager、ProfileLoader、および関連するリソースの SharePoint 2013 REST エンドポイントについて説明します。 |
|
フィード関連のタスクに対する SharePoint 2013 REST エンドポイントについて説明します。 |
|
以下のユーザーとコンテンツに対する SharePoint 2013 REST エンドポイントについて説明します。 |
SharePoint 2013 REST のコード サンプル
リソース |
説明 |
|---|---|
SharePoint アドイン REST インターフェイスを使用して SharePoint サイトに関する情報をリモート Web アプリケーションから読み取る、プロバイダー ホスト型の基本的な "hello world" SharePoint 2013 の作成法方を説明します。 |
|
SharePoint 2013 の検索内から SharePoint アドインに検索クエリを送信する方法を説明します。 |
|
SharePoint REST API を使用して SharePoint 2013サイトをスキャンする方法、および REST エンドポイントで公開されている SharePoint 基本エンティティに対して基本的なデータ操作を実行するクエリを構築するアプリを作成する方法を説明します。 |
|
SharePoint REST API を使用して SharePoint 2013 のリストおよびリスト アイテムに対する基本的なデータ アクセス操作を実行する方法を説明します。 |
|
REST および SharePointJavaScript クロスドメイン ライブラリを使用してドキュメント ライブラリとファイルに対する基本的な操作を実行するコード サンプルを示します。 |
|
AllowAppOnlyPolicy 属性を REST および OAuth とともに使用して、SharePoint 2013 へのコールバックを行う方法を説明します。 |
|
REST 対応の URL を使用して外部リスト内のデータに対するクエリの実行や操作を行う SharePoint アドインの作成方法を説明します。 |
|
クロム コントロールをホストし、SharePoint 2013 のクロスドメイン ライブラリと REST を使用してホスト Web から情報を取得するリモート Web ページを組み込む方法を説明します。 |
|
SharePoint アドインでクロスドメイン ライブラリを使用して、アプリ Web でホストされているリスト内のアイテムを読み取る方法を説明します。 |
|
SharePoint 2013: クロスドメイン ライブラリを使用してホスト Web のタイトルを取得する (REST) |
SharePoint 2013 のクロスドメイン ライブラリを使用して、ホスト Web の title プロパティを読み取る方法を説明します。 |
REST インターフェイスと SharePoint を使って JavaScript リストに緻密なアクセス許可を定義する方法について説明します。 |