GetById

Obtient ou met à jour les informations sur un site hub.

Requête HTTP

GET /_api/HubSites/GetById
POST /_api/HubSites/GetById

Paramètres d’URI

Nom Dans le paramètre Obligatoire Type Description
hubSiteId requête True string ID du site hub sur lequel vous souhaitez obtenir des informations.

En-têtes de demande

En-tête Valeur
Accepter application/json;odata=verbose
Content-Type application/json;odata=verbose;charset=utf-8
x-requestdigest Résumé approprié pour le site actuel.

Lorsque vous utilisez la méthode POST pour mettre à jour un site hub avec de nouvelles informations, utilisez les valeurs d’en-tête supplémentaires suivantes :

En-tête Valeur
X-HTTP-Method MERGE
If-Match *

Corps de la demande

Pour la méthode GET, le corps de demande n’est pas nécessaire. Lorsque vous utilisez la méthode POST pour mettre à jour un site hub avec de nouvelles informations, utilisez le corps suivant.

Nom Obligatoire Type Description
Titre Non string Nom d’affichage du site hub.
LogoUrl Non string URL d’un logo à utiliser dans la navigation du site hub.
Description Non string Description du site hub.

Réponses

Nom Type Description
200 OK SPHubSite Les informations sur le site hub ont été renvoyées avec succès.
204 Aucun contenu Le site hub a été mis à jour.

Exemples

Obtenir un site hub

Exemple de demande

GET
https://contoso.sharepoint.com/_api/HubSites/GetById?hubSiteId='f93eff08-5806-499c-92db-38800eefbe44'

Exemple de réponse

Code d’état : 200

{
    "@odata.context": "https://contoso.sharepoint.com/_api/$metadata#hubsites/$entity",
    "@odata.type": "#SP.HubSite",
    "@odata.id": "https://contoso.sharepoint.com/_api/HubSites/GetById",
    "@odata.etag": "\"3\"",
    "@odata.editLink": "HubSites/GetById",
    "Description": null,
    "ID": "f93eff08-5806-499c-92db-38800eefbe44",
    "LogoUrl": "https://contoso.sharepoint.com/sites/marketing/SiteAssets/__hubLogo____hubLogo__.png",
    "SiteId": "f93eff08-5806-499c-92db-38800eefbe44",
    "SiteUrl": "https://contoso.sharepoint.com/sites/marketing",
    "Targets": "<acl><ace identityName=\"c:0t.c|tenant|0d4b97fc-37fb-4db3-84f3-d34243a3afac\" displayName=\"0t.c|tenant|0d4b97fc-37fb-4db3-84f3-d34243a3afac\" sid=\"\" binaryIdType=\"1\" binaryId=\"YzowdC5jfHRlbmFudHwwZDRiOTdmYy0zN2ZiLTRkYjMtODRmMy1kMzQyNDNhM2FmYWM=\" allowRights=\"1\" denyRights=\"0\" /></acl>",
    "TenantInstanceId": "00000000-0000-0000-0000-000000000000",
    "Title": ""
}

Mise à jour d’un site hub

Exemple de demande

POST
https://contoso.sharepoint.com/_api/HubSites/GetById?hubSiteId='f93eff08-5806-499c-92db-38800eefbe44'

Exemple de réponse

Code d’état : 204

{
  "Title": "Marketing hub site",
  "LogoUrl": "https://contoso.sharepoint.com/sites/marketing/SiteAssets/__hubLogo____hubLogo__.png",
  "Description": "Hub site for marketing coordination"
}

Voir aussi