Freigeben über


Hubwebsite-REST-API

Sie können die SharePoint-REST-Schnittstelle dazu verwenden, Websites als Hubwebsites zu registrieren, vorhandene Websites Hubwebsites zuzuordnen sowie Informationen zu Hubwebsites abzurufen oder zu aktualisieren.

Der REST-Dienst in SharePoint Online (sowie in lokalen Bereitstellungen von SharePoint 2016 und höher) erlaubt die Zusammenfassung mehrerer Anforderungen in einem einzigen Aufruf an den Service mittels der ODATA-Abfrageoption „$batch“.

Einzelheiten und Links zu Codebeispielen finden Sie unter Durchführen von Batchanforderungen mit den REST-APIs.

Voraussetzungen

Lesen Sie vor der Umsetzung der Beispiele in diesem Artikel zunächst die folgenden Artikel:

REST-Befehle

Die folgenden REST-Befehle sind für die Arbeit mit Hubwebsites verfügbar:

  • SP. HubSites.CanCreate : Gibt zurück, ob der aktuelle Benutzer eine Hubwebsite erstellen kann. Nur Mandantenadministratoren können Hubwebsites erstellen.
  • GetById : Ruft Informationen zu einer Hubwebsite ab oder aktualisiert sie.
  • HubSiteData : Ruft Hubwebsitedaten für das aktuelle Web ab.
  • HubSites : Ruft Informationen zu allen Hubwebsites ab, auf die der aktuelle Benutzer zugreifen kann.
  • JoinHubSite : Ordnet eine Website einer vorhandenen Hubwebsite zu.
  • RegisterHubSite : Registriert eine vorhandene Website als Hubwebsite.
  • SyncHubSiteTheme : Wendet alle Designupdates von der übergeordneten Hubwebsite an.
  • UnRegisterHubSite : Hebt die Registrierung einer Hubwebsite auf, sodass sie keine Hubwebsite mehr ist.
  • SPHubSite-Objekttyp : Enthält Daten, die eine SharePoint-Hubwebsite beschreiben.
  • SPHubSiteData-Objekttyp : Enthält Daten, die eine SharePoint-Hubwebsite beschreiben.

Szenarien

Einige der folgenden Szenariobeispiele sind nicht intuitiv aus dem Methodennamen ersichtlich. Weitere Informationen finden Sie unter den Artikeln zu den einzelnen Cmdlets.

Aktualisieren einer Hubwebsite

Rufen Sie die GetById-Methode auf, um eine Hubwebsite zu aktualisieren.

Aufheben der Zuordnung einer Website zu ihrer Hubwebsite

Um eine Website von einer Hubwebsite zu entfernen oder zu trennen, rufen Sie JoinHubSite mit dem Wert „00000000-0000-0000-0000-000000000000“ auf.

Siehe auch