Web REST API リファレンス

[アーティクル]
07/18/2016

SharePoint REST API のサイト関連のリソースおよびエンドポイントについて説明します。

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

この記事の内容
この記事の要求の例について
Web リソース
WebCollection リソース
追加リソース

この記事の要求の例について

この記事に出てくる例では jQuery AJAX 要求が使用されています。これらの例を使用する前に、次の操作を実行してください。

<サイト url>、および ID、名前、SharePoint エンティティのパスなどその他プレースホルダーのデータを変更します。

クロスドメインライブラリを使用する場合は、要求形式を変更する必要があります。たとえば、次のようになります。

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web/getchanges?@target='<host web url>'",
  method: "POST",
  body: "{ 'query': { '__metadata': { 'type': 'SP.ChangeQuery' }, 'Web': true, 'Update': true } }",
  headers: {
    "accept": "application/json;odata=verbose",
    "content-type": "application/json;odata=verbose"
  },
  success: successHandler,
  error: errorHandler
});

OAuth を使用する場合は、Authorization ヘッダー ("Authorization": "Bearer " + <access token>) を追加して OAuth アクセストークンを送信します。
要求の例の url および data プロパティ値から改行を削除します。改行は、例を分かりやすくするために追加されています。
サーバーが Atom 形式で応答を返すようにするには、"accept": "application/json;odata=verbose" ヘッダーを削除します。

要求を変更する方法についての詳細は、「環境によって異なる REST 要求の方法」を参照してください。クロスドメインライブラリ、OAuth、および SharePoint サービスの使用法についての詳細は、「その他の技術情報」を参照してください。

ヒント

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

Web リソース

エンドポイント URI | プロパティ | メソッド | OData 表現

SharePoint リストを表します。リストは SP.SecurableObject の一種です。

エンドポイント URI

http://<サイトの url>/_api/web

サポートされる HTTP メソッド

GET | POST | DELETE | MERGE | PUT

要求の例

GET 要求の例: サイトを取得します。

$.ajax({
  url: "http://<site url>/_api/web",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

POST 要求の例:Add メソッドを使用して WebCollection リソースからサイトを作成します。

$.ajax({
  url: "http://<site url>/_api/web/webs/add",
  type: "POST",
  data: "{ 'parameters': { '__metadata': { 'type': 'SP.WebCreationInformation' },
    'Title': 'Team projects', 'Url': 'TeamProjects', 'WebTemplate': 'STS',
    'UseSamePermissionsAsParentSite': true } }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "accept": "application/json;odata=verbose",
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>
  },
  success: successHandler,
  error: errorHandler
});

または、REST によるサイトの作成」に示されているように、Add メソッドを WebInformationCollection リソースから使用できます。

MERGE 要求の例: サイトを変更します。

$.ajax({
  url: "http://<site url>/_api/web",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.Web' }, 'Description': 'All team projects',
    'EnableMinimalDownload': false }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "accept": "application/json;odata=verbose",
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>,
    "X-HTTP-Method": "MERGE"
  },
  success: successHandler,
  error: errorHandler
});

DELETE 要求の例: サイトを削除します

$.ajax({
  url: "http://<site url>/_api/web",
  type: "POST",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "X-HTTP-Method": "DELETE"
  },
  success: successHandler,
  error: errorHandler
});

Web プロパティ

プロパティを取得するには、以下の例に示されているように、GET 要求をプロパティエンドポイントに送信します。

$.ajax({
  url: "http://<site url>/_api/web/<property name>",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

プロパティ	型	R/W	リソースで返される	説明
AllowCreateDeclarativeWorkflowForCurrentUser	Boolean	R	いいえ	現在のユーザーが宣言型ワークフローを作成できるかどうかを指定します。Web アプリケーションで無効になっている場合、値はサイトコレクションの AllowCreateDeclarativeWorkflow プロパティと同じになります。既定値: true。
AllowDesignerForCurrentUser	Boolean	R	いいえ	現在のユーザーがデザイナーアプリケーションを使用してこのサイトをカスタマイズできるかどうかを示す値を取得します。
AllowMasterPageEditingForCurrentUser	Boolean	R	いいえ	現在のユーザーがマスターページを編集できるかどうかを示す値を取得します。
AllowRevertFromTemplateForCurrentUser	Boolean	R	いいえ	現在のユーザーがサイトを既定のサイトテンプレートに戻せるかどうかを示す値を取得します。
AllowRssFeeds	Boolean	R	はい	サイトで RSS フィードを許可するかどうかを示す値を取得します。
AllowSaveDeclarativeWorkflowAsTemplateForCurrentUser	Boolean	R	いいえ	現在のユーザーが宣言型ワークフローをテンプレートとして保存できるかを指定します。Web アプリケーションで無効になっている場合、値はサイトコレクションの AllowSaveDeclarativeWorkflowAsTemplateプロパティと同じになります。既定値: true。
AllowSavePublishDeclarativeWorkflowForCurrentUser	Boolean	RW	いいえ	現在のユーザーが宣言型ワークフローを保存するか、または発行するかを指定します。Web アプリケーションで無効になっている場合、値はサイトコレクションの AllowSavePublishDeclarativeWorkflowAsTemplate プロパティと同じになります。有効になっている場合、サイトコレクション管理者のみが設定できます。既定値: true。
AllProperties	SP.PropertyValues	R	いいえ	Web サイトのメタデータのコレクションを取得します。
AppInstanceId	GUID	R	はい	この Web が表すアプリインスタンスのインスタンス ID。
AssociatedMemberGroup	SP.Group	RW	いいえ	この Web サイトへの投稿のアクセス許可が与えられているユーザーのグループを取得または設定します。
AssociatedOwnerGroup	SP.Group	RW	いいえ	Web サイトの関連する所有者グループを取得または設定します。
AssociatedVisitorGroup	SP.Group	RW	いいえ	Web サイトの関連する閲覧者グループを取得または設定します。
AvailableContentTypes	SP.ContentTypeCollection	R	いいえ	現在の Web サイトおよびすべての親 Web サイトのコンテンツタイプなど、現在のスコープに適用されるすべてのコンテンツタイプのコレクションを取得します。
AvailableFields	SP.FieldCollection	R	いいえ	現在のサイトおよびすべての親サイトのフィールドなど、現在のスコープで使用できるすべてのフィールドのコレクションを示す値を取得します。
Configuration	Int16	R	はい	サイトの作成に使用されたサイト定義構成の識別子 (ID)、またはサイトの作成に使用されたサイトテンプレートの派生元であるサイト定義構成の ID を取得します。
ContentTypes	SP.ContentTypeCollection	R	いいえ	Web サイトのコンテンツタイプのコレクションを取得します。
Created	DateTime	R	はい	サイトが作成された日時を示す値を取得します。
CurrentUser	SP.User	R	いいえ	サイトの現在のユーザーを取得します。
CustomMasterUrl	String	RW	はい	Web サイトに適用するユーザー設定マスターページファイルの URL を取得または設定します。
Description	String	RW	はい	サイトの説明を取得または設定します。
DesignerDownloadUrlForCurrentUser	String	R	いいえ	現在のユーザーが SharePoint Designer をダウンロードできる URL を取得します。
DocumentLibraryCalloutOfficeWebAppPreviewersDisabled	Boolean	R	はい	ドキュメントライブラリの吹き出しの WAC プレビューアーが有効かどうかを決定します。
EffectiveBasePermissions	SP.BasePermissions	R	いいえ	アプリケーションプリンシパルおよびユーザープリンシパルの権限の共通部分を表します。アプリケーション専用の場合、このプロパティはアプリケーションプリンシパルの権限のみを返します。ユーザーの権限のみを確認する (アプリケーションの権限を無視する) には、GetUserEffectivePermissions メソッドを使用します。
EnableMinimalDownload	Boolean	RW	はい	Web サイトがダウンロード最小化戦略を使用する必要があるかどうかを指定するブール値を取得または設定します。
EventReceivers	SP.EventReceiverCollection	R	いいえ	Web サイト上で現在使用可能なイベントレシーバー定義のコレクションを取得します。
Features	SP.FeatureCollection	R	いいえ	サイトで現在アクティブになっている機能のコレクションを示す値を取得します。
Fields	SP.FieldCollection	R	いいえ	Web サイト内のすべてのフィールドを表すフィールドオブジェクトのコレクションを取得します。
Folders	SP.FolderCollection	R	いいえ	Web サイト内にある第 1 レベルのフォルダーすべてのコレクションを取得します。
Id	GUID	R	はい	サイトのサイト識別子を示す値を取得します。
Language	Int32	R	はい	サイトで使用される言語の LCID を示す値を取得します。
LastItemModifiedDate	DateTime	R	はい	サイトのアイテムが最後に更新された日付を示す値を取得します。
Lists	SP.ListCollection	R	いいえ	現在のユーザーのアクセス許可に基づいて、現在のユーザーが使用できる Web サイトに含まれているすべてのリストのコレクションを取得します。
ListTemplates	SP.ListTemplateCollection	R	いいえ	サイトでのリスト作成に使用できるリスト定義およびリストテンプレートのコレクションを示す値を取得します。
MasterUrl	String	RW	はい	Web サイトに使用されるマスターページの URL を取得または設定します。
Navigation	SP.Navigation	R	いいえ	サイドリンクバー領域や上部のナビゲーションバーを含む、サイト上のナビゲーション構造を示す値を取得します。
ParentWeb	SP.Web	R	いいえ	指定された Web サイトの親 Web サイトを取得します。
PushNotificationSubscribers	SP.PushNotificationSubscriberCollection	R	いいえ	サイト上でプッシュ通知サブスクライバーのコレクションを取得します。
QuickLaunchEnabled	Boolean	RW	はい	サイドリンクバー領域がサイトで有効かどうかを指定する値を取得または設定します。
RecycleBin	SP.RecycleBin	R	いいえ	サイトのごみ箱のアイテムのコレクションを指定します。
RecycleBinEnabled	Boolean	R	はい	Web サイトのごみ箱が有効かどうかを判定する値を取得または設定します。
RegionalSettings	SP.RegionalSettings	R	いいえ	Web サイトに現在実装されている地域設定を取得します。
RoleDefinitions	SP.RoleDefinitionCollection	R	いいえ	この Web サイトのロール定義のコレクションを取得します。
RootFolder	SP.Folder	R	いいえ	Web サイトのルートフォルダーを取得します。
SaveSiteAsTemplateEnabled	Boolean	RW	いいえ	Web サイトをサイトテンプレートとして保存できるかどうかを指定するブール値を取得または設定します。
ServerRelativeUrl	String	RW	はい	Web サイトのサーバー相対 URL を取得または設定します。
ShowUrlStructureForCurrentUser	Boolean	R	いいえ	現在のユーザーがこのサイトのファイルシステム構造を表示できるかどうかを示す値を取得します。
SiteGroups	SP.GroupCollection	R	いいえ	サイトコレクションのグループのコレクションを取得します。
SiteUserInfoList	SP.List	R	いいえ	この Web サイトが含まれているサイトコレクションの UserInfo リストを取得します。
SiteUsers	SP.UserCollection	R	いいえ	サイトコレクションに属するすべてのユーザーのコレクションを取得します。
SupportedUILanguageIds	Collection(Int32)	R	いいえ	サイトで有効になっている言語の言語コード識別子 (LCID) を指定します。
SyndicationEnabled	Boolean	RW	はい	RSS フィードがサイトで有効かどうかを指定する値を取得または設定します。
ThemeInfo	SP.ThemeInfo	R	いいえ	このサイトのテーマ情報。これには、色、フォント、枠の角の半径サイズなどの情報が含まれます。
Title	String	RW	はい	Web サイトのタイトルを取得または設定します。
TreeViewEnabled	Boolean	RW	はい	ツリービューがサイトで有効かどうかを指定する値を取得または設定します。
UIVersion	Int32	RW	はい	ユーザーインターフェイス (UI) バージョンの Web サイトを取得または設定します。
UIVersionConfigurationEnabled	Boolean	RW	はい	ビジュアルアップグレードの設定 UI が表示されるか、非表示であるかを指定する値を取得または設定します。
Url	String	R	はい	Web サイトの絶対 URL を取得します。
UserCustomActions	SP.UserCustomActionCollection	R	いいえ	サイトのユーザーカスタムアクションのコレクションを示す値を取得します。
WebInfos	SP.WebInformation	R	いいえ	サイトのサブサイトのキープロパティを表します。
Webs	SP.WebCollection	R	いいえ	この Web サイトの直下にあるすべての Web サイト (それらの Web サイトの子は除く) を表す Web サイトコレクションオブジェクトを取得します。
WebTemplate	String	R	はい	サイトの作成に使用されたサイト定義またはサイトテンプレートの名前を取得します。
WorkflowAssociations	SP.WorkflowAssociationCollection	R	いいえ	サイトのすべてのワークフロー関連付けのコレクションを示す値を取得します。
WorkflowTemplates	SP.WorkflowTemplateCollection	R	いいえ	サイトに関連付けられているワークフローテンプレートのコレクションを示す値を取得します。

Web メソッド

ApplyTheme
ApplyWebTemplate
BreakRoleInheritance
DeleteObject
DoesPushNotificationSubscriberExist
DoesUserHavePermissions
EnsureUser
ExecuteRemoteLOB
GetAppBdcCatalog
GetAppBdcCatalogForAppInstance
GetAppInstanceById
GetAppInstancesByProductId
GetAvailableWebTemplates
GetCatalog
GetChanges
GetContextWebInformation
GetEntity
GetDocumentLibraries
GetFileByServerRelativeUrl
GetFolderByServerRelativeUrl
GetList
GetPushNotificationSubscriber
GetPushNotificationSubscribersByArgs
GetPushNotificationSubscribersByUser
GetSubwebsFilteredForCurrentUser
GetUserById
GetUserEffectivePermissions
GetWebUrlFromPageUrl
LoadAndInstallApp
LoadAndInstallAppInSpecifiedLocale
LoadApp
MapsToIcon
ProcessExternalNotification
RegisterPushNotificationSubscriber
ResetRoleInheritance
UnregisterPushNotificationSubscriber

ApplyTheme メソッド

引数で指定されている各ファイルのコンテンツによって指定されるテーマを、サイトに適用します。

エンドポイント	/applytheme(colorpaletteurl、fontschemeurl、backgroundimageurl、sharegenerated)
パラメーター	colorpaletteurl 型: String カラーパレットファイルのサーバー相対 URL。 fontschemeurl 型: String フォントパターンのサーバー相対 URL。 backgroundimageurl 型: String 背景画像のサーバー相対 URL。 sharegenerated 型: Boolean 生成されたテーマファイルをルートサイトに保存する場合は true、またはそれらをこのサイトに保存する場合は false。
HTTP method	POST
応答	なし

要求の例

$.ajax({
  url: "http://<site url>/_api/web
    /applytheme(colorpaletteurl='/_catalogs/theme/15/palette011.spcolor',
        fontschemeurl='/_catalogs/theme/15/fontscheme007.spfont',
        backgroundimageurl='/piclibrary/th.jpg', sharegenerated=true)",
  type: "POST",
  headers: { "X-RequestDigest": <form digest value> },
  success: successHandler,
  error: errorHandler
});

または、以下のように本文でパラメーターを送信できます。{ 'colorPaletteUrl':'/_catalogs/theme/15/palette011.spcolor', 'fontSchemeUrl':'/_catalogs/theme/15/fontscheme007.spfont', 'backgroundImageUrl':'/piclibrary/pics/th.jpg', 'shareGenerated':true }

「SharePoint 2013 のテーマの概要」を参照してください。

ApplyWebTemplate メソッド

指定されたサイト定義またはサイトテンプレートを、テンプレートがまったく適用されていない Web サイトに適用します。

注意

適用されている同じサイト定義構成内で定義されたサイトプロビジョニングコールバック関数内でこのメソッドを呼び出すと、無限ループが発生する可能性があります。代わりに、2 つの同じサイト定義構成をサイト定義内に作成し、1 つは表示できるようにし、もう 1 つは表示できないようにします。次に、表示できる構成に、表示できない構成をサイトに適用するプロビジョニングアセンブリコールバックを含めることができます。

エンドポイント	/applywebtemplate('<サイト定義または Web テンプレート名>')
パラメーター	型: String サイト定義の名前またはサイトテンプレートの名前。使用可能なサイトテンプレートの名前を取得するには GetAvailableWebTemplates メソッドを使用します。
HTTP method	POST
応答	なし

要求の例

$.ajax({
  url: "http://<site url>/_api/web
    /applywebtemplate(@v)?@v='blog%230'",
  type: "POST",
  headers: { "X-RequestDigest": <form digest value> },
  success: successHandler,
  error: errorHandler
});

BreakRoleInheritance メソッド

セキュリティ設定が可能なオブジェクトの一意なロール割り当てを作成します。

エンドポイント	/breakroleinheritance(copyroleassignments、clearsubscopes)
パラメーター	copyroleassignments 型: Boolean ロール割り当てをセキュリティ設定が可能な親オブジェクトからコピーする場合は true、現在のユーザーを含むものを除き、継承されたロール割り当てを削除する場合は false。 clearsubscopes 型: Boolean 省略可能です。セキュリティ設定が可能なすべての子オブジェクトが現在のオブジェクトからロール割り当てを継承するようにする場合は true、親オブジェクトからロール割り当てを継承しないセキュリティ設定が可能な子オブジェクトのロール割り当てをそのままにする場合は false (既定)。
HTTP method	POST
応答	なし

要求の例

$.ajax({
  url: "http://<site url>/_api/web
    /breakroleinheritance(copyroleassignments=false, clearsubscopes=true)",
  method: "POST",
  headers: { "X-RequestDigest": <form digest value> },
  success: successHandler,
  error: errorHandler
});

DeleteObject メソッド

ビューを削除する推奨方法は、View 要求の例に示すように DELETE 要求を Web リソースのエンドポイントに送信することです。

DoesPushNotificationSubscriberExist メソッド

対象のデバイスアプリケーションインスタンス ID を持つ現在のユーザーに、プッシュ通知サブスクライバーが存在するかどうかをチェックします。

エンドポイント	/doespushnotificationsubscriberexist('<デバイスアプリインスタンス id >')
パラメーター	型: GUID デバイスアプリインスタンスの ID。
HTTP method	GET
応答	型: Boolean サブスクリプションが存在する場合は true、それ以外の場合は false。

DoesUserHavePermissions メソッド

現在のユーザーに所定のアクセス許可セットがあるかどうかを返します。

エンドポイント	/doesuserhavepermissions(@v)?@v={'High':'<value>', 'Low':'<value>'}
パラメーター	型: SP.BasePermissions 権限の上限および下限。サイト上の役割の権限の上限値および下限値を取得するには、…/_api/web/roledefinitions エンドポイントを使用します。
HTTP method	GET
応答	型: Boolean ユーザーが権限を持っている場合は true、それ以外の場合は false。

要求の例

$.ajax({
  url: "http://<site url>/_api/web
    /doesuserhavepermissions(@v)?@v={'High':'432', 'Low':'1012866047'}",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

EnsureUser メソッド

指定されたログイン名がサイトの有効なユーザーに属しているかどうか確認します。ユーザーが存在していない場合、サイトに追加します。

エンドポイント	/ensureuser
パラメーター	logonName 型: String ユーザーのログイン名。要求の例に示すように、要求の本文で logonName パラメータを渡します。
HTTP method	POST
応答	型: SP.User 指定されたユーザー。

要求の例

$.ajax({
  url: "http://<site url>/_api/web
    /ensureuser",
  type: "POST",
  data: "{ 'logonName': 'i:0#.f|membership|user@domain.onmicrosoft.com' }",
  headers: {
    "X-RequestDigest": <form digest value>,
    "accept": "application/json;odata=verbose"
  },
  success: successHandler,
  error: errorHandler
});

ExecuteRemoteLOB メソッド

OData サービスにデータを送信します。

このメソッドは、ハイブリッド接続のエントリポイントであり、OData サービスを社内サーバーから呼び出すために使用されます。OData サービスの呼び出しに必要な入力パラメーターはカスタム HTTP ヘッダーとして渡されます。「ExecuteRemoteLOB」を参照してください。

エンドポイント	/executeremotelob
パラメーター	inputStream 型: Stream OData 入力オブジェクト。作成または更新操作の場合にのみ使用されます。
HTTP method	POST
応答	型: Stream OData サービスからの OData 応答。

GetAppBdcCatalog メソッド

エンドポイント	/getappbdccatalog
パラメーター	なし
HTTP method	POST
応答	型: SP.BusinessData.AppBdcCatalog 現在のアプリインスタンス用の Business Data Connectivity (BDC) Service MetadataCatalog。

GetAppBdcCatalogForAppInstance メソッド

エンドポイント	/getappbdccatalogforappinstance('<アプリインスタンス id>')
パラメーター	型: GUID アプリインスタンスの ID。
HTTP method	POST
応答	型: SP.BusinessData.AppBdcCatalog 指定されたアプリインスタンス用の BDC MetadataCatalog。

GetAppInstanceById メソッド

このサイトにインストールされた AppInstance を取得します。

エンドポイント	/getappinstancebyid('<アプリインスタンス id>')
パラメーター	型: GUID アプリインスタンスの ID。
HTTP method	GET
応答	型: SP.AppInstance 指定されたアプリインスタンス。

要求の例

$.ajax({
  url: "http://<site url>/_api/web
    /getappinstancebyid('3122ea58-8435-4d9a-a302-345599838671')",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

GetAppInstancesByProductId メソッド

指定されたアプリのインスタンスである、このサイトにインストールされたすべての AppInstances を取得します。

エンドポイント	/getappinstancesbyproductid('<製品 id>')
パラメーター	型: GUID アプリの製品 ID。
HTTP method	GET
応答	型: Collection(SP.AppInstance) サイトにインストールされている、指定された製品のアプリインスタンス。

GetAvailableWebTemplates メソッド

サイトで使用できるサイトテンプレートのコレクションを返します。

エンドポイント	/getavailablewebtemplates(lcid、doincludecrosslanguage)
パラメーター	lcid 型: Int64 取得するサイトテンプレートの LCID。 doincludecrosslanguage 型: Boolean 言語非依存のサイトテンプレートを含めるにはtrue、それ以外の場合は false。
HTTP method	GET
応答	型: SP.WebTemplateCollection 使用可能なサイトテンプレートのコレクション。指定された LCID が無効である場合には空のコレクションが返されます。

要求の例

$.ajax({
  url: "http://<site url>/_api/web
    /getavailablewebtemplates(lcid=1033, doincludecrosslanguage=true)",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

GetCatalog メソッド

サイトのリストギャラリーを返します。

エンドポイント	/getcatalog(<ギャラリーの種類 >)
パラメーター	型: Int32 ギャラリーの種類。ListTemplateType 値を表します (WebTemplateCatalog = 111、WebPartCatalog = 113 ListTemplateCatalog = 114、MasterPageCatalog = 116、SolutionCatalog = 121、ThemeCatalog = 123、DesignCatalog = 124、AppDataCatalog = 125 など)。
HTTP method	GET
応答	型: SP.List 指定されたリストの種類のギャラリー。指定された種類のギャラリーが存在しないか、リストテンプレートの種類が無効である場合は null。

要求の例

$.ajax({
  url: "http://<site url>/_api/web
    /getcatalog(113)",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

GetChanges メソッド

指定されたクエリに基づいて、サイトのスコープ内で発生したすべての変更のコレクションを変更ログから返します。

エンドポイント	/getchanges
パラメーター	query 型: SP.ChangeQuery 変更クエリ。要求の例に示すように、要求の本文で query パラメーターを渡します。
HTTP method	POST
応答	型: SP.ChangeCollection 指定された変更クエリの基準と一致するサイトの変更。

要求の例

$.ajax({
  url: "http://<site url>/_api/web
    /getchanges",
  type: "POST",
  data: "{ 'query': { '__metadata': { 'type': 'SP.ChangeQuery' },
    'Web': true, 'Update': true, 'Add': true } }",
  headers: {
    "X-RequestDigest": <form digest value>
    "accept": "application/json;odata=verbose",
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>
  },
  success: successHandler,
  error: errorHandler
});

GetContextWebInformation

サイトのコンテキスト情報を取得します。静的メソッドです。

エンドポイント	http://<サイトの url>/_api/contextinfo
パラメーター	なし
HTTP method	POST
応答	型: SP.ContextWebInformation サイトのコンテキスト情報。

要求の例

$.ajax({
  url: "http://<site url>/_api
    /contextinfo",
  type: "POST",
  headers: {
    "X-RequestDigest": <form digest value>,
    "accept": "application/json;odata=verbose"
  },
  success: successHandler,
  error: errorHandler
});

GetCustomListTemplates メソッド

サイトのカスタムリストテンプレートを取得します。

エンドポイント	/getcustomlisttemplates
パラメーター	なし
HTTP method	GET
応答	型: SP.ListTemplateCollection サイトのカスタムリストテンプレート。

要求の例

$.ajax({
  url: "http://<site url>/_api/web
    /getcustomlisttemplates",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

GetDocumentLibraries メソッド

サイトのドキュメントライブラリを取得します。静的メソッドです。(SharePoint Online のみ)

エンドポイント	http://<サイトの url>/_api/sp.web.getdocumentlibraries(@v)?@v='<サイトの完全な url>'
パラメーター	型: String サイトの完全な URL。
HTTP method	GET
応答	型: Collection(SP.DocumentLibraryInformation) サイトのドキュメントライブラリのプロパティ。このメソッドでは、個人ライブラリ、写真ライブラリ、カタログライブラリ、アセットライブラリ、アプリケーションリスト、またはユーザーがアイテムを表示する権限を持っていないライブラリは返されません。

要求の例

$.ajax({
  url: "http://<site url>/_api
    /sp.web.getdocumentlibraries(@v)?@v='https://contoso.sharepoint.com'",
  method: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler});

GetEntity メソッド

基幹業務 (LOB) システムアプリケーションで指定された外部コンテンツタイプを取得します。

エンドポイント	/getentity(namespace, name)
パラメーター	namespace 型: String 外部コンテンツタイプの名前空間。 name 型: String 外部コンテンツタイプの名前。
HTTP method	POST
応答	型: SP.BusinessData.Entity 外部コンテンツタイプ。

GetFileByServerRelativeUrl メソッド

指定されたサーバー相対 URL にあるファイルオブジェクトを返します。

エンドポイント	/getfilebyserverrelativeurl('<サーバー相対 url>')
パラメーター	型: String ファイルのサーバー相対 URL。
HTTP method	GET
応答	型: SP.File 指定されたファイル。

要求の例

$.ajax({
  url: "http://<site url>/_api/web
    /getfilebyserverrelativeurl('/templates/ResourceRequest.docx')",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

GetFolderByServerRelativeUrl メソッド

指定されたサーバー相対 URL にあるフォルダーオブジェクトを返します。

エンドポイント	/getfolderbyserverrelativeurl('<サーバー相対 url>')
パラメーター	型: String フォルダーのサーバー相対 URL。
HTTP method	GET
応答	型: SP.Folder 指定されたフォルダー。

要求の例

$.ajax({
  url: "http://<site url>/_api/web
    /getfolderbyserverrelativeurl('/templates/test')",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

GetList メソッド

指定されたサイト相対 URL の一覧を取得します (SharePoint Online のみ)。

エンドポイント	/getlist('<一覧 url>')
パラメーター	型: String 一覧のサイト相対 URL。
HTTP method	GET
応答	型: SP.List 指定された一覧。

要求の例

$.ajax({
  url: "http://<site url>/_api/web
    /getlist('/lists/ideas')",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

GetPushNotificationSubscriber メソッド

指定されたデバイスアプリケーションインスタンス ID について、サイト上でプッシュ通知サブスクライバーを取得します。

エンドポイント	/getpushnotificationsubscriber('<デバイスアプリインスタンス id>')
パラメーター	型: GUID デバイスアプリインスタンスの ID。
HTTP method	GET
応答	型: SP.PushNotificationSubscriber 登録済みのプッシュ通知のサブスクライバー。

GetPushNotificationSubscribersByArgs メソッド

ユーザー設定引数の指定値に対する、サイト上のプッシュ通知サブスクライバーのクエリ。Null または空のユーザー設定引数は、フィルターせずにサブスクライバーを返します。

エンドポイント	/getpushnotificationsubscribersbyargs('<arguments>')
パラメーター	型: String 結果をフィルター処理する引数。渡される引数はストア内のサブスクライバーのカスタム引数と比較されます。フィルター処理されていない結果を返すには、null または空の引数を渡します。
HTTP method	GET
応答	型: SP.PushNotificationSubscriberCollection 引数と一致する、登録済みのプッシュ通知のサブスクライバー。一致が見つからなかった場合は、空のコレクションを返します。

GetPushNotificationSubscribersByUser メソッド

指定されたユーザーについての、サイト上のプッシュ通知サブスクライバーのクエリ。

エンドポイント	/getpushnotificationsubscribersbyuser(@v)?@v='<ログイン名>'
パラメーター	型: String ユーザーのログイン名。クエリ文字列でログイン名を渡すために使用される形式については、「ユーザー」を参照してください。
HTTP method	GET
応答	型: SP.PushNotificationSubscriberCollection ユーザーの登録済みのプッシュ通知のサブスクライバー。

GetSubwebsFilteredForCurrentUser メソッド

指定されたクエリに基づいて現在のサイトの子サイトのコレクションを返します。

SharePoint Online でのみ利用できます。

エンドポイント	/getsubwebsfilteredforcurrentuser(nwebtemplatefilter, nconfigurationfilter)
パラメーター	nwebtemplatefilter 型: Int32 サイトのサイト定義で使用するテンプレートの ID。 nconfigurationfilter 型: Int16 サイトを準備するために使用するサイトテンプレートの ID。
HTTP method	GET
応答	型: Collection(SP.WebInformation) 現在のユーザーがアクセスできるサイトについての情報。

要求の例

$.ajax({
  url: "http://<site url>/_api/web
    /getsubwebsfilteredforcurrentuser(nwebtemplatefilter=-1,nconfigurationfilter=0)",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

GetUserById メソッド

現在のサイトの指定されたメンバー識別子に対応するユーザーを返します。

エンドポイント	/removebyid(<ユーザー id>)
パラメーター	型: Int32 ユーザーの ID。
HTTP method	GET
応答	型: SP.User 指定されたユーザー

要求の例

$.ajax({
  url: "http://<site url>/_api/web
    /getuserbyid(12)",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

GetUserEffectivePermissions メソッド

現在のアプリケーションスコープ内で、指定されたユーザーの有効なアクセス許可を取得します。

現在のユーザー以外のユーザーの権限を確認するには、アプリがサイトの Full Control 権限を持っている必要があります。

エンドポイント	/getusereffectivepermissions(@v)?@v='<ログイン名>'
パラメーター	型: String ユーザーのログイン名。クエリ文字列でログイン名を渡すために使用される形式については、「ユーザー」を参照してください。
HTTP method	GET
応答	型: SP.BasePermissions 指定したユーザーの権限。

要求の例

$.ajax({
  url: "http://<site url>/_api/web
    /getusereffectivepermissions(@v)?@v='i%3A0%23.f%7Cmembership%7Cuser%40domain.onmicrosoft.com'",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

GetWebUrlFromPageUrl メソッド

ページの URL からサイトの URL を取得します。静的メソッドです。

エンドポイント	http://<サイトの url>/_api/sp.web.getweburlfrompageurl(@v)?@v='<ページの完全な url>'
パラメーター	型: String SharePoint ページの完全な URL。必要に応じて URL エンコード文字を使用します。
HTTP method	GET
応答	型: String SharePoint サイトの完全な URL。

要求の例

$.ajax({
  url: "http://<site url>/_api
    /sp.web.getweburlfrompageurl(@v)?@v='https://contoso.sharepoint.com/subsite/_layouts/15/start.aspx'",
  method: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

LoadAndInstallApp メソッド

このサイトにアプリパッケージをアップロードしてインストールします。

リモート開発用にこのサイトを有効にする必要があります。

エンドポイント	/loadandinstallapp
パラメーター	appPackageStream 型: Stream アプリパッケージストリーム。
HTTP メソッド	POST
応答	型: SP.AppInstance アプリインスタンス。

LoadAndInstallAppInSpecifiedLocale メソッド

指定されたロケールのサイトにアプリパッケージをアップロードしてインストールします。

エンドポイント	/loadandinstallappinspecifiedlocale
パラメーター	appPackageStream 型: Stream アプリパッケージストリーム。 installationLocaleLCID 型: Int32 アプリインスタンスの作成に使用するロケールの LCID。
HTTP method	POST
応答	型: SP.AppInstance アプリインスタンス。

LoadApp メソッド

アプリパッケージをアップロードし、そのアプリパッケージからインスタンスを作成します。

エンドポイント	/loadapp
パラメーター	appPackageStream 型: Stream アプリパッケージストリーム。 installationLocaleLCID 型: Int32 アプリインスタンスの作成に使用するロケールの LCID。
HTTP method	POST
応答	型: SP.AppInstance アプリインスタンス。

MapToIcon メソッド

指定されたファイルの表示に使用されるアイコンのイメージファイルの名前を返します。

エンドポイント	/maptoicon(filename, progid, size)
パラメーター	filename Type: String このパラメーターが空の場合、サーバーは空の文字列を返します。 progid 型: String 形式が ProgID の、ファイルの作成に使用されたアプリケーションの OLEServerName.ObjectName (例、Excel.Sheet または PowerPoint.Slide)。これは、オブジェクトを一意に識別するために Windows レジストリによって使用される ID です。 size 型: Int32 アイコンのサイズ: 16x16 ピクセル = 0, 32x32 ピクセル = 1。
HTTP method	GET
応答	型: String アイコンイメージファイルの名前。

要求の例

$.ajax({
  url: "http://<site url>/_api/web
    /maptoicon(filename='spectemplate.docx', progid='', size=0)",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

ProcessExternalNotification メソッド

外部システムからの通知を処理します。

エンドポイント	/processexternalnotification
パラメーター	stream 型: Stream 外部システムからの通知メッセージ。
HTTP method	POST
応答	型: String 処理ステータス: Success は正常に処理されたことを示し、SubscriptionNotRequired はサブスクリプションが不要になり、安全に削除できることを示します。

RegisterPushNotificationSubscriber メソッド

サイト上でプッシュ通知のサブスクライバーを登録します。登録が既に存在する場合は、サービストークンが新しい値に更新されます。

エンドポイント	/registerpushnotificationsubscriber(deviceappinstanceid, servicetoken)
パラメーター	deviceappinstanceid 型: GUID デバイスアプリインスタンスの ID。 servicetoken 型: String 通知サービスにより、通知を受け取るデバイスに提供されるトークン。
HTTP method	POST
応答	型: SP.PushNotificationSubscriber 登録済みのプッシュ通知のサブスクライバー。

ResetRoleInheritance メソッド

セキュリティ設定が可能なオブジェクトのロール継承をリセットし、ロールの割り当てをセキュリティ設定可能な親のオブジェクトから継承します。

エンドポイント	/resetroleinheritance
パラメーター	なし
HTTP method	POST
応答	なし

要求の例

$.ajax({
  url: "http://<site url>/_api/web
    /resetroleinheritance",
  method: "POST",
  headers: { "X-RequestDigest": <form digest value> },
  success: successHandler,
  error: errorHandler
});

UnregisterPushNotificationSubscriber メソッド

サイトからプッシュ通知のサブスクライバーの登録を解除します。

エンドポイント	/unregisterpushnotificationsubscriber('<デバイスアプリインスタンス id>')
パラメーター	型: GUID デバイスアプリインスタンスの ID。
HTTP method	POST
応答	なし

OData 表現

次の例は、JSON 形式による Web リソースを表します。

    {"d":{
      "__metadata":{
        "id":"https://<site url>/_api/Web",
        "uri":"https://<site url>/_api/Web",
        "type":"SP.Web"
      },
      "FirstUniqueAncestorSecurableObject":{"__deferred":{"uri":"https://<site url>/_api/Web/FirstUniqueAncestorSecurableObject"}},
      "RoleAssignments":{"__deferred":{"uri":"https://<site url>/_api/Web/RoleAssignments"}},
      "AllProperties":{"__deferred":{"uri":"https://<site url>/_api/Web/AllProperties"}},
      "AssociatedMemberGroup":{"__deferred":{"uri":"https://<site url>/_api/Web/AssociatedMemberGroup"}},
      "AssociatedOwnerGroup":{"__deferred":{"uri":"https://<site url>/_api/Web/AssociatedOwnerGroup"}},
      "AssociatedVisitorGroup":{"__deferred":{"uri":"https://<site url>/_api/Web/AssociatedVisitorGroup"}},
      "AvailableContentTypes":{"__deferred":{"uri":"https://<site url>/_api/Web/AvailableContentTypes"}},
      "AvailableFields":{"__deferred":{"uri":"https://<site url>/_api/Web/AvailableFields"}},
      "ContentTypes":{"__deferred":{"uri":"https://<site url>/_api/Web/ContentTypes"}},
      "CurrentUser":{"__deferred":{"uri":"https://<site url>/_api/Web/CurrentUser"}},
      "DescriptionResource":{"__deferred":{"uri":"https://<site url>/_api/Web/DescriptionResource"}},
      "EventReceivers":{"__deferred":{"uri":"https://<site url>/_api/Web/EventReceivers"}},
      "Features":{"__deferred":{"uri":"https://<site url>/_api/Web/Features"}},
      "Fields":{"__deferred":{"uri":"https://<site url>/_api/Web/Fields"}},
      "Folders":{"__deferred":{"uri":"https://<site url>/_api/Web/Folders"}},
      "Lists":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists"}},
      "ListTemplates":{"__deferred":{"uri":"https://<site url>/_api/Web/ListTemplates"}},
      "Navigation":{"__deferred":{"uri":"https://<site url>/_api/Web/Navigation"}},
      "ParentWeb":{"__deferred":{"uri":"https://<site url>/_api/Web/ParentWeb"}},
      "PushNotificationSubscribers":{"__deferred":{"uri":"https://<site url>/_api/Web/PushNotificationSubscribers"}},
      "RecycleBin":{"__deferred":{"uri":"https://<site url>/_api/Web/RecycleBin"}},
      "RegionalSettings":{"__deferred":{"uri":"https://<site url>/_api/Web/RegionalSettings"}},
      "RoleDefinitions":{"__deferred":{"uri":"https://<site url>/_api/Web/RoleDefinitions"}},
      "RootFolder":{"__deferred":{"uri":"https://<site url>/_api/Web/RootFolder"}},
      "SiteGroups":{"__deferred":{"uri":"https://<site url>/_api/Web/SiteGroups"}},
      "SiteUserInfoList":{"__deferred":{"uri":"https://<site url>/_api/Web/SiteUserInfoList"}},
      "SiteUsers":{"__deferred":{"uri":"https://<site url>/_api/Web/SiteUsers"}},
      "ThemeInfo":{"__deferred":{"uri":"https://<site url>/_api/Web/ThemeInfo"}},
      "TitleResource":{"__deferred":{"uri":"https://<site url>/_api/Web/TitleResource"}},
      "UserCustomActions":{"__deferred":{"uri":"https://<site url>/_api/Web/UserCustomActions"}},
      "Webs":{"__deferred":{"uri":"https://<site url>/_api/Web/Webs"}},
      "WebInfos":{"__deferred":{"uri":"https://<site url>/_api/Web/WebInfos"}},
      "WorkflowAssociations":{"__deferred":{"uri":"https://<site url>/_api/Web/WorkflowAssociations"}},
      "WorkflowTemplates":{"__deferred":{"uri":"https://<site url>/_api/Web/WorkflowTemplates"}},
      "AllowRssFeeds":true,
      "AppInstanceId":"d025f690-8281-4cb7-ab11-04793e232661",
      "Configuration":0,
      "Created":"2014-02-27T20:08:25",
      "CustomMasterUrl":"/_catalogs/masterpage/app.master",
      "Description":"",
      "DocumentLibraryCalloutOfficeWebAppPreviewersDisabled":false,
      "EnableMinimalDownload":false,
      "Id":"ba0bfd3d-ba13-4400-aacf-f60d56eecfbc",
      "Language":1033,
      "LastItemModifiedDate":"2014-02-27T20:08:28Z",
      "MasterUrl":"/_catalogs/masterpage/app.master",
      "QuickLaunchEnabled":true,
      "RecycleBinEnabled":true,
      "ServerRelativeUrl":"",
      "SyndicationEnabled":true,
      "Title":"ParseUm",
      "TreeViewEnabled":false,
      "UIVersion":15,
      "UIVersionConfigurationEnabled":false,
      "Url":"https://<site url>",
      "WebTemplate":"APP"
    }}

WebCollection リソース

エンドポイント URI | メソッド | OData 表現

サイトのコレクションを表します。

エンドポイント URI

http://<サイト url>/_api/web/webs

サポートされる HTTP メソッド

GET | POST

要求の例

GET 要求の使用例: サイト内のすべてのサブサイトを取得します。

$.ajax({
  url: "http://<site url>/_api/web/webs",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

POST 要求の例:Add メソッドを使用することによってサイトを作成します

$.ajax({
  url: "http://<site url>/_api/web/webs/add",
  type: "POST",
  data: "{ 'parameters': { '__metadata': { 'type': 'SP.WebCreationInformation' },
    'Title': 'Social Meetup', 'Url': 'social', 'WebTemplate': 'MPS#3',
    'UseSamePermissionsAsParentSite': true } }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "accept": "application/json;odata=verbose",
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>
  },
  success: successHandler,
  error: errorHandler
});

または、REST によるサイトの作成」に示されているように、Add メソッドを WebInformationCollection リソースから使用できます。

サイトを変更または削除する方法の例については、「Web 要求の例」を参照してください。

WebCollection メソッド

Add

Add メソッド

新しい Web サイトをコレクションに追加します。

エンドポイント	/add
パラメーター	parameters 型: SP.WebCreationInformation 新しいサイトのプロパティ。要求の例に示されているように、要求本文でこのパラメーターを送信します。
HTTP method	POST
応答	型: SP.Web 新しいサイト。

要求の例

$.ajax({
  url: "http://<site url>/_api/web/webs
    /add",
  type: "POST",
  data: "{ 'parameters': { '__metadata': { 'type': 'SP.WebCreationInformation' },
    'Title': 'Social Meetup', 'Url': 'social', 'WebTemplate': 'MPS#3',
    'UseSamePermissionsAsParentSite': true } }",
  headers: {
    "X-RequestDigest": <form digest value>,
    "accept": "application/json;odata=verbose",
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>
  },
  success: successHandler,
  error: errorHandler
});

使用可能なサイトテンプレートの名前を取得するには GetAvailableWebTemplates メソッドを使用します。

OData 表現

次の例は、JSON　形式での WebCollection リソースを表しています。

    {"d":{
      "results":[{
          "__metadata":{
            "id":"https://<site url>/_api/Web",
            "uri":"https://<site url>/_api/Web",
            "type":"SP.Web"
          },
          "FirstUniqueAncestorSecurableObject":{"__deferred":{"uri":"https://<site url>/_api/Web/FirstUniqueAncestorSecurableObject"}},
          "RoleAssignments":{"__deferred":{"uri":"https://<site url>/_api/Web/RoleAssignments"}},
          "AllProperties":{"__deferred":{"uri":"https://<site url>/_api/Web/AllProperties"}},
          "AssociatedMemberGroup":{"__deferred":{"uri":"https://<site url>/_api/Web/AssociatedMemberGroup"}},
          "AssociatedOwnerGroup":{"__deferred":{"uri":"https://<site url>/_api/Web/AssociatedOwnerGroup"}},
          "AssociatedVisitorGroup":{"__deferred":{"uri":"https://<site url>/_api/Web/AssociatedVisitorGroup"}},
          "AvailableContentTypes":{"__deferred":{"uri":"https://<site url>/_api/Web/AvailableContentTypes"}},
          "AvailableFields":{"__deferred":{"uri":"https://<site url>/_api/Web/AvailableFields"}},
          "ContentTypes":{"__deferred":{"uri":"https://<site url>/_api/Web/ContentTypes"}},
          "CurrentUser":{"__deferred":{"uri":"https://<site url>/_api/Web/CurrentUser"}},
          "DescriptionResource":{"__deferred":{"uri":"https://<site url>/_api/Web/DescriptionResource"}},
          "EventReceivers":{"__deferred":{"uri":"https://<site url>/_api/Web/EventReceivers"}},
          "Features":{"__deferred":{"uri":"https://<site url>/_api/Web/Features"}},
          "Fields":{"__deferred":{"uri":"https://<site url>/_api/Web/Fields"}},
          "Folders":{"__deferred":{"uri":"https://<site url>/_api/Web/Folders"}},
          "Lists":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists"}},
          "ListTemplates":{"__deferred":{"uri":"https://<site url>/_api/Web/ListTemplates"}},
          "Navigation":{"__deferred":{"uri":"https://<site url>/_api/Web/Navigation"}},
          "ParentWeb":{"__deferred":{"uri":"https://<site url>/_api/Web/ParentWeb"}},
          "PushNotificationSubscribers":{"__deferred":{"uri":"https://<site url>/_api/Web/PushNotificationSubscribers"}},
          "RecycleBin":{"__deferred":{"uri":"https://<site url>/_api/Web/RecycleBin"}},
          "RegionalSettings":{"__deferred":{"uri":"https://<site url>/_api/Web/RegionalSettings"}},
          "RoleDefinitions":{"__deferred":{"uri":"https://<site url>/_api/Web/RoleDefinitions"}},
          "RootFolder":{"__deferred":{"uri":"https://<site url>/_api/Web/RootFolder"}},
          "SiteGroups":{"__deferred":{"uri":"https://<site url>/_api/Web/SiteGroups"}},
          "SiteUserInfoList":{"__deferred":{"uri":"https://<site url>/_api/Web/SiteUserInfoList"}},
          "SiteUsers":{"__deferred":{"uri":"https://<site url>/_api/Web/SiteUsers"}},
          "ThemeInfo":{"__deferred":{"uri":"https://<site url>/_api/Web/ThemeInfo"}},
          "TitleResource":{"__deferred":{"uri":"https://<site url>/_api/Web/TitleResource"}},
          "UserCustomActions":{"__deferred":{"uri":"https://<site url>/_api/Web/UserCustomActions"}},
          "Webs":{"__deferred":{"uri":"https://<site url>/_api/Web/Webs"}},
          "WebInfos":{"__deferred":{"uri":"https://<site url>/_api/Web/WebInfos"}},
          "WorkflowAssociations":{"__deferred":{"uri":"https://<site url>/_api/Web/WorkflowAssociations"}},
          "WorkflowTemplates":{"__deferred":{"uri":"https://<site url>/_api/Web/WorkflowTemplates"}},
          "AllowRssFeeds":true,
          "AppInstanceId":"9f85a4a6-3609-44d6-9427-e7a5f16ceeeb",
          "Configuration":0,
          "Created":"2013-10-03T19:45:27",
          "CustomMasterUrl":"/apppart/_catalogs/masterpage/app.master",
          "Description":"",
          "DocumentLibraryCalloutOfficeWebAppPreviewersDisabled":false,
          "EnableMinimalDownload":false,
          "Id":"2dbf86de-6538-4d1a-b4fe-2a8e9816d692",
          "Language":1033,
          "LastItemModifiedDate":"2013-10-03T19:45:30Z",
          "MasterUrl":"/apppart/_catalogs/masterpage/app.master",
          "QuickLaunchEnabled":true,
          "RecycleBinEnabled":true,
          "ServerRelativeUrl":"/apppart",
          "SyndicationEnabled":true,
          "Title":"apppart",
          "TreeViewEnabled":false,
          "UIVersion":15,
          "UIVersionConfigurationEnabled":false,
          "Url":"https://<site url>",
          "WebTemplate":"APP"
        },{
        "__metadata":{
          "id":"https://<site url>,
          "uri":"https://<site url>,
          "type":"SP.Web"
        },
          "FirstUniqueAncestorSecurableObject":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/FirstUniqueAncestorSecurableObject"}},
          "RoleAssignments":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/RoleAssignments"}},
          "AllProperties":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/AllProperties"}},
          "AssociatedMemberGroup":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/AssociatedMemberGroup"}},
          "AssociatedOwnerGroup":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/AssociatedOwnerGroup"}},
          "AssociatedVisitorGroup":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/AssociatedVisitorGroup"}},
          "AvailableContentTypes":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/AvailableContentTypes"}},
          "AvailableFields":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/AvailableFields"}},
          "ContentTypes":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/ContentTypes"}},
          "CurrentUser":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/CurrentUser"}},
          "DescriptionResource":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/DescriptionResource"}},
          "EventReceivers":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/EventReceivers"}},
          "Features":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/Features"}},
          "Fields":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/Fields"}},
          "Folders":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/Folders"}},
          "Lists":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/Lists"}},
          "ListTemplates":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/ListTemplates"}},
          "Navigation":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/Navigation"}},
          "ParentWeb":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/ParentWeb"}},
          "PushNotificationSubscribers":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/PushNotificationSubscribers"}},
          "RecycleBin":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/RecycleBin"}},
          "RegionalSettings":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/RegionalSettings"}},
          "RoleDefinitions":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/RoleDefinitions"}},
          "RootFolder":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/RootFolder"}},
          "SiteGroups":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/SiteGroups"}},
          "SiteUserInfoList":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/SiteUserInfoList"}},
          "SiteUsers":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/SiteUsers"}},
          "ThemeInfo":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/ThemeInfo"}},
          "TitleResource":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/TitleResource"}},
          "UserCustomActions":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/UserCustomActions"}},
          "Webs":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/Webs"}},
          "WebInfos":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/WebInfos"}},
          "WorkflowAssociations":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/WorkflowAssociations"}},
          "WorkflowTemplates":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/WorkflowTemplates"}},
          "AllowRssFeeds":true,
          "AppInstanceId":"00000000-0000-0000-0000-000000000000",
          "Configuration":0,
          "Created":"2014-02-28T21:41:11",
          "CustomMasterUrl":"/TeamProjects/_catalogs/masterpage/seattle.master",
          "Description":"",
          "DocumentLibraryCalloutOfficeWebAppPreviewersDisabled":false,
          "EnableMinimalDownload":true,
          "Id":"3a37226d-8f0b-41bd-a720-6f63fd1e2abb",
          "Language":1033,
          "LastItemModifiedDate":"2014-02-28T21:41:23Z",
          "MasterUrl":"/TeamProjects/_catalogs/masterpage/seattle.master",
          "QuickLaunchEnabled":true,
          "RecycleBinEnabled":true,
          "ServerRelativeUrl":"/TeamProjects",
          "SyndicationEnabled":true,
          "Title":"Team projects",
          "TreeViewEnabled":false,
          "UIVersion":15,
          "UIVersionConfigurationEnabled":false,
          "Url":"https://<site url>/TeamProjects",
          "WebTemplate":"STS"
        },{
          ...
        }
      }]
    }}

Web REST API リファレンス

この記事の要求の例について

Web リソース

エンドポイント URI

サポートされる HTTP メソッド

要求の例

Web プロパティ

Web メソッド

ApplyTheme メソッド

ApplyWebTemplate メソッド

BreakRoleInheritance メソッド

DeleteObject メソッド

DoesPushNotificationSubscriberExist メソッド

DoesUserHavePermissions メソッド

EnsureUser メソッド

ExecuteRemoteLOB メソッド

GetAppBdcCatalog メソッド

GetAppBdcCatalogForAppInstance メソッド

GetAppInstanceById メソッド

GetAppInstancesByProductId メソッド

GetAvailableWebTemplates メソッド

GetCatalog メソッド

GetChanges メソッド

GetContextWebInformation

GetCustomListTemplates メソッド

GetDocumentLibraries メソッド

GetEntity メソッド

GetFileByServerRelativeUrl メソッド

GetFolderByServerRelativeUrl メソッド

GetList メソッド

GetPushNotificationSubscriber メソッド

GetPushNotificationSubscribersByArgs メソッド

GetPushNotificationSubscribersByUser メソッド

GetSubwebsFilteredForCurrentUser メソッド

GetUserById メソッド

GetUserEffectivePermissions メソッド

GetWebUrlFromPageUrl メソッド

LoadAndInstallApp メソッド

LoadAndInstallAppInSpecifiedLocale メソッド

LoadApp メソッド

MapToIcon メソッド

ProcessExternalNotification メソッド

RegisterPushNotificationSubscriber メソッド

ResetRoleInheritance メソッド

UnregisterPushNotificationSubscriber メソッド

OData 表現

WebCollection リソース

エンドポイント URI

サポートされる HTTP メソッド

要求の例

WebCollection メソッド

Add メソッド

OData 表現

追加リソース

その他のリソース