Partager via

Gérer des sites modernes SharePoint à l’aide de REST

  • Article

Cette rubrique part du principe que vous êtes déjà familiarisé avec les rubriques suivantes :

Cette rubrique ne fournit pas d’extraits de code. Les exemples suivants supposent l’utilisation d’un en-tête HTTP Accept application/json;odata.metadata=none.

Les commandes REST suivantes sont disponibles pour la création d’un site de communication SharePoint moderne :

  • Création. Créer un nouveau site SharePoint.
  • Supprimer. Créer un site SharePoint.
  • État. Obtenir l’état d’un site SharePoint.

L’URL de base des commandes REST est _api/SPSiteManager.

Créer un site moderne

À l’aide de l’API REST suivante, vous pouvez créer des sites de communication et des sites d’équipe associés Non groupés.

Pour spécifier le type de site à créer, vous devez utiliser l’attribut WebTemplate. Utilisez l’un des modèles suivants pour sélectionner le type de site que vous voulez créer :

  • Site de communication :SITEPAGEPUBLISHING#0
  • Site d’équipe Non-associé au groupe : STS#3
url: /_api/SPSiteManager/create
accept: application/json;odata.metadata=none
odata-version: 4.0
method: POST
body:
{
  "request": {
    "Title": "Communication Site 1",
    "Url":"https://contoso.sharepoint.com/sites/commsite1",
    "Lcid": 1033,
    "ShareByEmailEnabled":false,
    "Classification":"Low Business Impact",
    "SensitivityLabel": "<Your sensitivity label ID>",
    "Description":"Description",
    "WebTemplate":"SITEPAGEPUBLISHING#0",
    "SiteDesignId":"6142d2a0-63a5-4ba0-aede-d9fefca2c767",
    "Owner":"owner@yourtenant.onmicrosoft.com",
    "WebTemplateExtensionId":"00000000-0000-0000-0000-000000000000"
  }
}

Importante

Si vous utilisez un contexte d’application uniquement pour créer la collection de sites, la Propriété propriétaire est requise. Dans d’autres cas, il s’agit d’une propriété facultative qui, si elle n’est pas présente, est utilisée par défaut pour l’utilisateur appelant le point de terminaison REST.

Remarque

Le paramètre « Classification » définit uniquement la valeur visible sur le site, mais n’applique pas l’étiquette sur le site. Utilisez le nouveau paramètre « SensitivityLabel » pour appliquer l’étiquette à votre collection de sites.

L’ID de conception de site peut être récupérée à l’aide des applets de commande Get-SPOSiteDesign ( Microsoft SharePoint Online Management Shell) ou Get-PnPSiteDesign (PNP PowerShell). Si vous voulez appliquer une conception de site disponible par défaut, utilisez les valeurs suivantes :

  • Rubrique : 96c933ac-3698-44c7-9f4a-5fd17d71af9e ou Null
  • Présentation :6142d2a0-63a5-4ba0-aede-d9fefca2c767
  • Vide : f6cc5403-0d63-442e-96c0-285923709ffc

Importante

Pour appliquer vos conceptions de site personnalisées telles que récupérées avec Get-SPOSiteDesign (Microsoft SharePoint Online Management Shell) ou Get-PnPSiteDesign (PnP PowerShell), vous devez modifier le JSON comme suit :

...
    "SiteDesignId":"00000000-0000-0000-0000-000000000000",
    "Owner":"owner@yourtenant.onmicrosoft.com",
    "WebTemplateExtensionId":"<your site design ID>"
...

Remarque

PnP PowerShell est une solution open source pour laquelle un support est assuré par la communauté active. Il n’existe pas de contrat SLA Microsoft pour le support technique relatif à cet outil open source.

Réponse

Si elle réussit, cette méthode renvoie un code de réponse 200, OK et un objet JSON simple dans le corps de la réponse avec les détails suivants :

{
  "SiteId":"d11e59ca-1465-424c-be90-c847ba849af5",
  "SiteStatus":2,
  "SiteUrl":"https://contoso.sharepoint.com/sites/commsite1"
}

Supprimer un site moderne

L’API REST pour supprimer un site moderne est la suivante :

url: /_api/SPSiteManager/delete
method: POST
accept: application/json;odata.metadata=none
odata-version: 4.0
body:
{
  "siteId":"d11e59ca-1465-424c-be90-c847ba849af5"
}

Réponse

Si elle réussit, cette méthode renvoie un code de réponse 200, OK.

Obtenir l’état moderne d’un site

L’API REST pour obtenir l’état d’un site de communication SharePoint moderne :

url: /_api/SPSiteManager/status?url='https%3A%2F%2Fcontoso.sharepoint.com%2Fsites%2Fcommsite1'
method: GET
accept: application/json;odata.metadata=none
odata-version: 4.0
body: none

Réponse

Si elle réussit, cette méthode renvoie un code de réponse 200, OK et un objet JSON simple dans le corps de la réponse avec les détails suivants :

Si le site existe, la réponse renvoie l’état du site et l’URL du site :

{
  "SiteId":"d11e59ca-1465-424c-be90-c847ba849af5",
  "SiteStatus":2,
  "SiteUrl":"https://contoso.sharepoint.com/sites/comm1"
}

Si le site n’existe pas, la réponse revoie un état du site égal à 0 et aucune URL, et aucun ID de site.

{
  "SiteId":,
  "SiteStatus":0,
  "SiteUrl":
}

L’ensemble des valeurs pour SiteStatus suit :

  • 0 – Introuvable. Le site n’existe pas.
  • 1 – Approvisionnement. Le site est actuellement en cours d’approvisionnement.
  • 2 – Prêt. Le site a été créé.
  • 3 – Erreur. Une erreur s'est produite lors de l’approvisionnement du site.
  • 4 - Le site avec l’URL demandée existe déjà.

Voir aussi