API REST de site hub

Vous pouvez utiliser l’interface REST de SharePoint pour inscrire des sites en tant que sites hub, pour associer des sites existants à des sites hub et pour obtenir ou mettre à jour les informations sur les sites hub.

Le service REST SharePoint Online (et SharePoint sur site 2016 et ultérieur) prend en charge la combinaison de plusieurs requêtes en un seul appel au service à l’aide de l’option de requête $batch OData.

Pour plus d’informations et des liens vers des exemples de code, consultez la rubrique Créer des requêtes de lots avec l’API REST.

Conditions préalables

Avant de commencer, assurez-vous que vous connaissez les éléments suivants :

Commandes REST

Les commandes REST suivantes peuvent être utilisées avec des sites hub :

  • SP.HubSites.CanCreate – indique si l’utilisateur actuel peut créer un site hub. Seuls les administrateurs du client peuvent créer des sites hub.
  • GetById – obtient ou met à jour les informations sur un site hub.
  • HubSiteData– obtient les données de site hub pour le site web actuel.
  • HubSites– récupère les informations sur tous les sites hub auxquels l’utilisateur actuel peut accéder.
  • JoinHubSite – associe un site à un site hub existant.
  • RegisterHubSite – inscrit un site existant en tant que site hub.
  • SyncHubSiteTheme – applique les mises à jour du thème du site hub parent.
  • UnRegisterHubSite – annule l’inscription d’un site en tant que site hub.
  • Type d'objet SPHubSite – contient les données décrivant un site hub SharePoint.
  • Type d'objet SPHubSiteData – contient des données décrivant un site hub SharePoint.

Scénarios

Certains exemples de scénarios suivants ne sont pas intuitifs par rapport au nom de la méthode. Pour plus d’informations, consultez chaque article de cmdlet.

Mise à jour d’un site hub

Appelez la méthode GetById pour mettre à jour un site hub.

Dissociation d’un site par rapport à son site hub

Pour supprimer ou dissocier un site d’un site hub, appliquez la méthode JoinHubSite avec la valeur « 00000000-0000-0000-0000-000000000000 ».

Voir aussi