SharePointのRESTコマンドのまとめです。
今回は、WebのREST APIのまとめです。
SharePoint REST サービスとは
SharePoint の RESTの概要は以下を参照ください。
Web
エンドポイント URI
http://<サイトの url>/_api/web
メソッド | HTTP method | 説明 |
---|---|---|
ApplyTheme | POST | 引数で指定されている各ファイルのコンテンツによって指定されるテーマを、サイトに適用します。 |
ApplyWebTemplate | POST | 指定されたサイト定義またはサイト テンプレートを、テンプレートがまったく適用されていない Web サイトに適用します。 |
BreakRoleInheritance | POST | セキュリティ設定が可能なオブジェクトの一意なロール割り当てを作成します。 |
DoesPushNotificationSubscriberExist | GET | 対象のデバイス アプリケーション インスタンス ID を持つ現在のユーザーに、プッシュ通知サブスクライバーが存在するかどうかをチェックします。 |
DoesUserHavePermissions | GET | 現在のユーザーに所定のアクセス許可セットがあるかどうかを返します。 |
EnsureUser | POST | 指定されたログイン名がサイトの有効なユーザーに属しているかどうか確認します。ユーザーが存在していない場合、サイトに追加します。 |
ExecuteRemoteLOB | POST | OData サービスにデータを送信します。 |
GetAppInstanceById | GET | このサイトにインストールされた AppInstance を取得します。 |
GetAppInstancesByProductId | GET | 指定されたアプリのインスタンスである、このサイトにインストールされたすべての AppInstances を取得します。 |
GetAvailableWebTemplates | GET | サイトで使用できるサイト テンプレートのコレクションを返します。 |
GetCatalog | GET | サイトのリスト ギャラリーを返します。 |
GetChanges | POST | 指定されたクエリに基づいて、サイトのスコープ内で発生したすべての変更のコレクションを変更ログから返します。 |
GetContextWebInformation | POST | サイトのコンテキスト情報を取得します。 |
GetCustomListTemplates | GET | サイトのカスタム リスト テンプレートを取得します。 |
GetDocumentLibraries | GET | サイトのドキュメント ライブラリを取得します。 |
GetFileByServerRelativeUrl | GET | 指定されたサーバー相対 URL にあるファイル オブジェクトを返します。 |
GetFolderByServerRelativeUrl | GET | 指定されたサーバー相対 URL にあるフォルダー オブジェクトを返します。 |
GetList | GET | 指定されたサイト相対 URL の一覧を取得します |
GetPushNotificationSubscriber | GET | 指定されたデバイス アプリケーション インスタンス ID について、サイト上でプッシュ通知サブスクライバーを取得します。 |
GetPushNotificationSubscribersByArgs | GET | ユーザー設定引数の指定値に対する、サイト上のプッシュ通知サブスクライバーのクエリ。Null または空のユーザー設定引数は、フィルターせずにサブスクライバーを返します。 |
GetPushNotificationSubscribersByUser | GET | 指定されたユーザーについての、サイト上のプッシュ通知サブスクライバーのクエリ。 |
GetSubwebsFilteredForCurrentUser | GET | 指定されたクエリに基づいて現在のサイトの子サイトのコレクションを返します。 |
GetUserById | GET | 現在のサイトの指定されたメンバー識別子に対応するユーザーを返します。 |
GetUserEffectivePermissions | GET | 現在のアプリケーション スコープ内で、指定されたユーザーの有効なアクセス許可を取得します。 |
GetWebUrlFromPageUrl | GET | ページの URL からサイトの URL を取得します。静的メソッドです。 |
LoadAndInstallApp | POST | このサイトにアプリ パッケージをアップロードしてインストールします。 |
LoadAndInstallAppInSpecifiedLocale | POST | 指定されたロケールのサイトにアプリ パッケージをアップロードしてインストールします。 |
LoadApp | POST | アプリ パッケージをアップロードし、そのアプリ パッケージからインスタンスを作成します。 |
MapsToIcon | GET | 指定されたファイルの表示に使用されるアイコンのイメージ ファイルの名前を返します。 |
ProcessExternalNotification | POST | 外部システムからの通知を処理します。 |
RegisterPushNotificationSubscriber | POST | サイト上でプッシュ通知のサブスクライバーを登録します。登録が既に存在する場合は、サービス トークンが新しい値に更新されます。 |
ResetRoleInheritance | POST | セキュリティ設定が可能なオブジェクトのロール継承をリセットし、ロールの割り当てをセキュリティ設定可能な親のオブジェクトから継承します。 |
UnregisterPushNotificationSubscriber | POST | サイトからプッシュ通知のサブスクライバーの登録を解除します。 |
WebCollection
エンドポイント URI
http://<サイトの url>/_api/web/webs
メソッド | HTTP method | 説明 |
---|---|---|
Add | POST | 新しい Web サイトをコレクションに追加します。 |