ハブ サイトの REST API
SharePoint REST インターフェイスを使用すると、サイトをハブ サイトとして登録し、既存のサイトをハブ サイトに関連付け、ハブ サイトに関する情報を取得または更新することができます。
SharePoint Online (および SharePoint 2016 以降のオンプレミス) REST サービスでは、OData $batch クエリ オプションを使って、サービスに対する複数の要求を 1 つの呼び出しに統合できます。
詳細とコード サンプルへのリンクについては、「REST API によりバッチ要求を発行する」を参照してください。
前提条件
作業の開始前に、次に示す事項について十分に理解しておいてください。
REST コマンド
ハブ サイトを操作するため、次の REST コマンドを使用できます。
- Sp。HubSites.CanCreate – 現在のユーザーがハブ サイトを作成できるかどうかを返します。 テナント管理者のみがハブ サイトを作成できます。
- GetById – ハブ サイトに関する情報を取得または更新します。
- HubSiteData – 現在の Web のハブ サイト データを取得します。
- HubSites – 現在のユーザーがアクセスできるすべてのハブ サイトに関する情報を取得します。
- JoinHubSite – サイトを既存のハブ サイトに関連付けます。
- RegisterHubSite – 既存のサイトをハブ サイトとして登録します。
- SyncHubSiteTheme – 親ハブ サイトからのすべてのテーマ更新プログラムを適用します。
- UnRegisterHubSite – ハブ サイトの登録を解除して、ハブ サイトが不要になるようにします。
- SPHubSite オブジェクトの種類 – SharePoint ハブ サイトを記述するデータが含まれます。
- SPHubSiteData オブジェクトの種類 – SharePoint ハブ サイトを記述するデータが含まれます。
シナリオ
次に示すシナリオ例の中には、メソッドの名前からは直感的に理解できないものがあります。 詳細については、各コマンドレットの記事をご覧ください。
ハブ サイトを更新する
GetById メソッドを呼び出して、ハブ サイトを更新します。
ハブ サイトからサイトの関連付けを解除する
ハブ サイトからサイトを削除、または関連付けを解除するには、値を「00000000-0000-0000-0000-000000000000」として、JoinHubSite を呼び出します。