SharePoint 2013 REST API リファレンス

SharePoint 2013 開発の Representational State Transfer (REST) インターフェイスに関する情報を入手できます。

最終更新日:2015年3月9日

適用対象:apps for SharePoint | SharePoint Online | SharePoint Server 2013

社内環境用に開発する SharePoint ソリューションおよびアプリでは、REST インターフェイスを使用して SharePoint データとやり取りできます。REST ベースのアプリはアセンブリまたはライブラリを参照する必要はなく、HTTP Web リクエストをサポートする任意のテクノロジを使用して作成できます。

オンプレミス環境で開発された SharePoint アドインは、Office 365 環境で開発されたアプリと同じパターンに従います。SharePoint ソリューションはファイアーウォールの内部で実行するため SharePoint でホストされるアプリと似ているので、REST の呼び出しは現在のユーザーの資格情報を使用して認証され、フォーム ダイジェストの値を __REQUESTDIGEST ページ コントロールから取得できます (例: $("#__REQUESTDIGEST").val())。

メモ メモ

他のクライアント側 API には、REST にはない利点があります。たとえば、REST の呼び出しは常に非同期に送信されます。REST インターフェイスが最善のオプションかどうかを判断する際の参考としては、「SharePoint 2013 での適切な API セットの選択」をご覧ください。

ヒント ヒント

SharePoint Online REST サービスは、OData $batch クエリ オプションを使用して複数の要求を、サービスに対する 1 つの呼び出しに結合できます。詳細とコード サンプルへのリンクについては、「REST API によりバッチ要求を発行する」をご覧ください。このオプションは、オンプレミスの SharePoint ではサポートされていません。

メモ メモ

以下のリンクのいくつかは、対応する JavaScript オブジェクトのドキュメントを開き、ページの最後に REST エンドポイントを表示します。

REST コア リソース

リソース

説明

SP へChangeCollection オブジェクト (sp.js)

SP.Change オブジェクトのコレクションを表します。

SP へEventReceiverDefinitionCollection オブジェクト (sp.js)

Microsoft SharePoint Foundation オブジェクトの登録されたイベント レシーバーのリストを列挙するのに使用される EventReceiverDefinition オブジェクトのコレクションを表します。

SP へEventReceiverDefinition オブジェクト (sp.js)

SP へFeatureCollection オブジェクト (sp.js)

SP.Feature オブジェクトのコレクションを表します。

SP へ機能のオブジェクト (sp.js)

アクティブ化された機能を表します。

SP へRecycleBinItemCollection オブジェクト (sp.js)

SP.RecycleBinItem オブジェクトのコレクションを表します。

SP へRecycleBinItem オブジェクト (sp.js)

サイトまたはサイト コレクションのごみ箱内にあるごみ箱アイテムを表します。

SP へまずオブジェクト (sp.js)

Microsoft SharePoint Foundation を実行しているサーバー上で使用される地域設定を表します。

SP へサイト オブジェクト (sp.js)

トップレベルの Web サイトとそのすべてのサブサイトを含む、Web アプリケーション内のサイトのコレクションを表します。

SP へTimeZoneCollection オブジェクト (sp.js)

SP へタイムゾーン オブジェクト (sp.js)

Web

SharePoint サイトを表します。

SP へWebTemplateCollection オブジェクト (sp.js)

サイト テンプレートのコレクションを指定します。

SP へWeb テンプレート オブジェクト (sp.js)

サイトのインスタンス化に使用されるサイト定義またはサイト テンプレートを指定します。

REST リスト関連リソース

リソース

説明

ListCollection

List リソースのコレクションを表します。

List

SharePoint Web サイト上のリストを表します。

ListItemCollection

ListItem リソースのコレクションを表します。

ListItem

リスト内のアイテムまたは行を表します。

SP へContentTypeCollection オブジェクト (sp.js)

Web サイトまたはリスト コンテンツ タイプのコレクションを表します。

SP へコンテンツ タイプのオブジェクト (sp.js)

Web サイト (リスト) のコンテンツ タイプを表します。

FieldCollection

Field リソースのコレクションを表します。

Field

Microsoft SharePoint Foundation Web サイト上にあるリスト内のフィールドを表します。

SP へFieldLinkCollection オブジェクト (sp.js)

コンテンツ タイプ内の列またはフィールド参照である SP.FieldLink オブジェクトのコレクションを表します。

SP へフィールド リンク オブジェクト (sp.js)

コンテンツ タイプのフィールドまたはフィールド定義への参照を指定します。

SP へFormCollection オブジェクト (sp.js)

リストの SP.Form オブジェクトのコレクションを表します。

SP へフォームのオブジェクト (sp.js)

フォームは 1 つのリスト アイテムの表示および編集用インターフェイスを提供します。

SP.InformationRightsManagementSettings オブジェクト (sp.js)

SP へListTemplateCollection オブジェクト (sp.js)

SP.ListTemplate オブジェクトのコレクションを表します。

SP へListTemplate オブジェクト (sp.js)

リスト テンプレートを指定します。

SP へRelatedFieldCollection オブジェクト (sp.js)

リレーションシップ ルックアップ フィールドのプロパティを格納している SP.RelatedField オブジェクトのコレクションを表します。

SP へありますオブジェクト (sp.js)

ルックアップ フィールドに対するリレーションシップを指定します。

ViewCollection

View リソースのコレクションを表します。

View

リスト ビューを指定します。

ViewFieldCollection

リスト ビュー内のフィールドのコレクションを表します。

ファイルおよびフォルダーの REST リソース

リソース

説明

FileCollection

File リソースのコレクションを表します。

File

SharePoint Web サイト内のファイルを表します。このファイルは、Web パーツ ページ、ドキュメント ライブラリ内のアイテム、またはフォルダー内のファイルのいずれかになります。

FileVersionCollection

FileVersion リソースのコレクションを表します。

FileVersion

File リソースのバージョンを表します。

FolderCollection

Folder リソースのコレクションを表します。

Folder

SharePoint Web サイト上のフォルダーを表します。

ユーザーおよびグループの REST リソース

リソース

説明

GroupCollection

Group リソースのコレクションを表します。

Group

Microsoft SharePoint Foundation Web サイト上のグループを表します。

RoleAssignmentCollection

セキュリティ設定が可能なオブジェクトのすべてのロール割り当てを定義する、RoleAssignment リソースのコレクションを表します。

RoleAssignment

Web サイト、リスト、またはリスト アイテム上でユーザーまたはグループに対するセキュリティ設定が可能なオブジェクトのロール割り当てを定義します。

RoleDefinitionCollection

サイト内で使用できるロール定義を定義する RoleDefinition リソースのコレクションを表します。

RoleDefinition

名前、説明、および権利セットを含む 1 つのロール定義を設定します。

RoleDefinitionBindingCollection

ロール割り当てオブジェクトにバインドされたロール定義を定義します。

UserCollection

User リソースのコレクションを表します。

User

Microsoft SharePoint Foundation 内のユーザーを表します。

UserCustomActionCollection

UserCustomAction リソースのコレクションを表します。

UserCustomAction

SharePoint リスト、Web サイト、またはサブサイトに関連付けられているカスタム アクションを表します。

リソース

説明

SharePoint 2013 REST サービスの概要

SharePoint 2013 REST サービスの基本的な使用方法を紹介し、REST および OData Web プロトコル標準を使用して SharePoint データにアクセスして更新する方法について説明します。

SharePoint 2013 REST エンドポイントを使用して基本的な操作を完了する

SharePoint 2013 REST インターフェイスを使用して基本的な CRUD 操作を実行する方法を説明します。

SharePoint 検索 REST API の概要

SharePoint Server 2013 の検索 REST サービスと、REST Web 要求をサポートするテクノロジを使用してクライアント アプリケーションとモバイル アプリケーションに検索機能を追加します。

SharePoint 2013 ソーシャル フィード REST API リファレンス

フィード関連タスクに関する SharePoint 2013 REST エンドポイントについて説明します。

SharePoint 2013 でのユーザーやコンテンツのフォローに関する REST API リファレンス

以下のユーザーとコンテンツに関する SharePoint 2013 REST エンドポイントについて説明します。

表示: