API REST de conception de site et de script de site

Article
04/08/2023

Vous pouvez utiliser l’interface REST SharePoint pour effectuer des opérations CRUD (créer, lire, mettre à jour et supprimer) de base sur les conceptions de site et les scripts de site.

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 les conceptions de site et les scripts de site :

CreateSiteScript : crée un script de site.
GetSiteScripts : obtient une liste d’informations sur les scripts de site existants.
GetSiteScriptFromWeb : crée la syntaxe de script de site à partir d’un site SharePoint existant.
GetSiteScriptFromList : crée la syntaxe de script de site à partir d’une liste SharePoint existante.
GetSiteScriptMetadata : obtient des informations sur un script de site spécifique.
UpdateSiteScript : Mises à jour un script de site avec de nouvelles valeurs.
DeleteSiteScript : supprime un script de site.
CreateSiteDesign : crée une conception de site.
ApplySiteDesign : applique une conception de site à une collection de sites existante.
AddSiteDesignTaskToCurrentWeb : ajoute une tâche de conception de site sur le site web actuel.
GetSiteDesigns : obtient une liste d’informations sur les conceptions de site existantes.
GetSiteDesignMetadata : obtient des informations sur une conception de site spécifique.
UpdateSiteDesign : Mises à jour une conception de site avec de nouvelles valeurs.
DeleteSiteDesign : supprime une conception de site.
GetSiteDesignRights : obtient une liste de principaux ayant accès à une conception de site.
GrantSiteDesignRights : accorde l’accès à une conception de site pour un ou plusieurs principaux.
RevokeSiteDesignRights : révoque l’accès à partir d’une conception de site pour un ou plusieurs principaux.

Créer une fonction pour envoyer des demandes REST

Pour utiliser l’API REST, nous recommandons de créer une fonction d’assistance pour effectuer les appels REST. La fonction RestRequest suivante appelle la méthode REST spécifiée dans le paramètre url et transmet les paramètres supplémentaires dans params.

function RestRequest(url,params) {
  var req = new XMLHttpRequest();
  req.onreadystatechange = function ()
  {
    if (req.readyState != 4) // Loaded
      return;
    console.log(req.responseText);
  };

  // Prepend web URL to url and remove duplicated slashes.
  var webBasedUrl = (_spPageContextInfo.webServerRelativeUrl + "//" + url).replace(/\/{2,}/,"/");
  req.open("POST",webBasedUrl,true);
  req.setRequestHeader("Content-Type", "application/json;charset=utf-8");
  req.setRequestHeader("ACCEPT", "application/json; odata.metadata=minimal");
  req.setRequestHeader("x-requestdigest", _spPageContextInfo.formDigestValue);
  req.setRequestHeader("ODATA-VERSION","4.0");
  req.send(params ? JSON.stringify(params) : void 0);
}

CreateSiteScript

Crée un script de site.

Paramètres

Paramètre	Description
Titre	Nom d’affichage de la conception de site.
Contenu	Valeur JSON qui décrit le script. Pour plus d’informations, reportez-vous à la rubrique Référence JSON.

Exemples

L’exemple suivant crée un script de site qui applique un thème personnalisé.

var site_script =
{
  "$schema": "schema.json",
  "actions": [
    {
      "verb": "applyTheme",
      "themeName": "Contoso Theme"
    }
  ],
  "bindata": { },
  "version": 1
};

RestRequest("/_api/Microsoft.SharePoint.Utilities.WebTemplateExtensions.SiteScriptUtility.CreateSiteScript(Title=@title)?@title='Contoso theme script'", site_script);

Voici un exemple de référence JSON renvoyée après avoir appelé la commande CreateSiteScript. Il contient l’ID du nouveau script de site.

{
  "@odata.context": "https://contoso.sharepoint.com/_api/$metadata#Microsoft.SharePoint.Utilities.WebTemplateExtensions.SiteScriptMetadata",
  "Content": null,
  "Description": null,
  "Id": "7647d3d6-1046-41fe-a798-4ff66b099d12",
  "Title": "Contoso customer list",
  "Version": 0
}

GetSiteScripts

Obtient une liste d’informations sur tous les scripts de site existants.

Paramètres

Aucun.

Exemples

L’exemple suivant obtient les informations de tous les scripts de site.

RestRequest("/_api/Microsoft.SharePoint.Utilities.WebTemplateExtensions.SiteScriptUtility.GetSiteScripts");

Voici un exemple de référence JSON renvoyée après avoir appelé la commande GetSiteScripts.

{
  "@odata.context": "https://contoso.sharepoint.com/_api/$metadata#Collection(Microsoft.SharePoint.Utilities.WebTemplateExtensions.SiteScriptMetadata)",
  "value": [
    {
      "Content": null,
      "Description": null,
      "Id": "6dfedb96-c090-44e3-875a-1c38032715fc",
      "Title": "Customer orders",
      "Version": 1
    },
    {
      "Content": null,
      "Description": null,
      "Id": "07702c07-0485-426f-b710-4704241caad9",
      "Title": "Contoso theme",
      "Version": 1
    }
  ]
}

GetSiteScriptFromWeb

Obtient la syntaxe du script de site pour un site SharePoint spécifique.

Paramètres

Paramètre	Description
webUrl	L’URL qui commence par HTTPS du site pour récupérer le script de site.
IncludeBranding	(facultatif) True si la personnalisation est extraite ; sinon False.
IncludedLists	(facultatif) Tableau d’une ou plusieurs listes. Chacune d’entre elles est identifiée par une URL de liste.
IncludeRegionalSettings	(facultatif) True si les paramètres régionaux sont extraits ; sinon False.
IncludeSiteExternalSharingCapability	(facultatif) True si la fonctionnalité de partage externe est extraite ; sinon False.
IncludeTheme	(facultatif) True si le thème personnalisé est extrait ; sinon False.
IncludeLinksToExportedItems	(facultatif) True si les liens de navigation sont extraits ; sinon False. Afin d’exporter les liens de navigation pointant vers des listes, la liste doit également être incluse dans la demande.

Remarque

Au moins un paramètre Inclure doit être fourni lors de l’utilisation de cette API, sinon la requête échoue.

Exemples

Voici un exemple de récupération d’un objet JSON de script de site à partir de la collection de sites Contoso.

RestRequest("/_api/Microsoft.SharePoint.Utilities.WebTemplateExtensions.SiteScriptUtility.GetSiteScriptFromWeb", {
   "webUrl":"https://contoso.sharepoint.com/",
   "info":{
      "IncludeBranding":true,
      "IncludedLists":[
         "Lists/Contoso customer list"
      ],
      "IncludeRegionalSettings":true,
      "IncludeSiteExternalSharingCapability":true,
      "IncludeTheme":true,
      "IncludeLinksToExportedItems":true
   }
});

Voici un exemple de référence JSON renvoyée après avoir appelé la commande GetSiteScriptFromWeb.

Remarque

L’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité.

{
    "$schema": "https://developer.microsoft.com/json-schemas/sp/site-design-script-actions.schema.json",
    "actions": [
      {
        "verb": "createSPList",
        "listName": "Contoso customer list",
        "templateType": 100,
        "subactions": [
          {
            "verb": "addSPView",
            "name": "All Items",
            "viewFields": [
              "LinkTitle"
            ],
            "query": "",
            "rowLimit": 30,
            "isPaged": true,
            "makeDefault": true,
            "addLink": "Contoso customer list"
          }
        ]
      },
      {
        "verb": "setSiteBranding",
        "navigationLayout": "Cascade",
        "headerLayout": "Standard",
        "headerBackground": "None",
        "showFooter": false
      },
      {
        "verb": "applyTheme",
        "themeJson": {
          "version": "2",
          "isInverted": false,
          "palette": {
            "neutralPrimaryAlt": "#ff4b4b4b",
            "themeLighterAlt": "#fff1faf0",
            "black": "#ff1d1d1d",
            "themeTertiary": "#ff55ae48",
            "primaryBackground": "#ffffffff"
          }
        }
      },
      {
        "verb": "setSiteExternalSharingCapability",
        "capability": "ExternalUserSharingOnly"
      },
      {
        "verb": "setRegionalSettings",
        "timeZone": 13,
        "locale": 1033,
        "sortOrder": 25,
        "hourFormat": "12"
      },
      {
        "verb": "addNavLink",
        "url": "/Lists/Contoso customer list",
        "displayName": "Contoso customer list",
        "isWebRelative": true,
        "navComponent": "QuickLaunch"
      }
    ]
  }

GetSiteScriptFromList

Obtient la syntaxe du script de site pour une liste spécifique.

Paramètres

Paramètre	Description
listUrl	URL de la liste pour récupérer le script de site

Exemples

Voici un exemple de récupération d’un objet JSON de script de site à partir de la liste de clients Contoso.

RestRequest("/_api/Microsoft.SharePoint.Utilities.WebTemplateExtensions.SiteScriptUtility.GetSiteScriptFromList", {listUrl: "https://consoso.sharepoint.com/sites/projectgo/Lists/Contoso%20customer%20list"});

Voici un exemple de référence JSON renvoyée après avoir appelé la commande GetSiteScriptFromList.

{"@odata.context":"https://constoso.sharepoint.com/sites/projectgo/_api/$metadata#Edm.String","value":"{
  "actions": [
    {
      "verb": "createSPList",
      "listName": "Contoso customer list",
      "templateType": 100,
      "subactions": [
        {
          "verb": "addSPView",
          "name": "All Items",
          "viewFields": [
            "LinkTitle"
          ],
          "query": "",
          "rowLimit": 30,
          "isPaged": true,
          "makeDefault": true
        }
      ]
    },
    {
      "verb": "addNavLink",
      "url": "Lists/Contoso customer list/AllItems.aspx",
      "displayName": "Contoso customer list",
      "isWebRelative": true
    }
  ]
}"}

GetSiteScriptMetadata

Obtient des informations sur un script de site spécifique. Cette commande renvoie également la référence JSON du script.

Paramètres

Paramètre	Description
id	ID du script de site sur lequel vous souhaitez obtenir des informations.

RestRequest("/_api/Microsoft.SharePoint.Utilities.WebTemplateExtensions.SiteScriptUtility.GetSiteScriptMetadata",
{id:"07702c07-0485-426f-b710-4704241caad9"});

Exemples

Voici un exemple de référence JSON renvoyée après avoir appelé la commande GetSiteScriptMetadata.

{
  "@odata.context": "https://contoso.sharepoint.com/_api/$metadata#Microsoft.SharePoint.Utilities.WebTemplateExtensions.SiteScriptMetadata",
  "Content": "{\r\n    \"$schema\": \"schema.json\",\r\n        \"actions\": [\r\n            {\r\n               \"verb\": \"applyTheme\",\r\n               \"themeName\": \"Custom Cyan\"\r\n            }\r\n        ],\r\n            \"bindata\": { },\r\n    \"version\": 1\r\n}",
  "Description": null,
  "Id": "07702c07-0485-426f-b710-4704241caad9",
  "Title": "Contoso theme",
  "Version": 1
}

UpdateSiteScript

Met à jour un script de site avec de nouvelles valeurs. Dans l’appel REST, tous les paramètres sont facultatifs à l’exception de l’ID du script de site.

Paramètres

Paramètre	Description
ID	ID du script de site à mettre à jour.
Titre	(Facultatif) Nouveau nom d’affichage du script de site.
Description	(Facultatif) Nouvelle description du script de site.
Version	(Facultatif) Nouveau numéro de version du script de site.
Contenu	(Facultatif) Nouveau script JSON définissant les actions du script. Pour en savoir plus, consultez la rubrique Schéma JSON de conception de site

Exemples

Cet exemple met à jour un script de site existant avec un nouveau script et de nouvelles valeurs JSON.

var updated_site_script =
{
  "$schema": "schema.json",
  "actions": [
    {
      "verb": "applyTheme",
      "themeName": "Contoso Theme"
    }
  ],
  "bindata": { },
  "version": 2
};

RestRequest("/_api/Microsoft.SharePoint.Utilities.WebTemplateExtensions.SiteScriptUtility.UpdateSiteScript",
{updateInfo:{
  Id:"07702c07-0485-426f-b710-4704241caad9",
  Title:"New Contoso theme",
  Description:"Updated Contoso site script",
  Version: 2,
  Content: JSON.stringify(updated_site_script)}});

Voici un exemple de référence JSON renvoyée après avoir appelé la commande UpdateSiteScript.

{
  "@odata.context": "https://contoso.sharepoint.com/_api/$metadata#Microsoft.SharePoint.Utilities.WebTemplateExtensions.SiteScriptMetadata",
  "Content": "{\"$schema\":\"schema.json\",\"actions\":[{\"verb\":\"applyTheme\",\"themeName\":\"Contoso Theme\"}],\"bindata\":{},\"version\":2}",
  "Description": "Updated Contoso site script",
  "Id": "07702c07-0485-426f-b710-4704241caad9",
  "Title": "New Contoso theme",
  "Version": 2
}

DeleteSiteScript

Supprime un script de site.

Paramètres

Paramètre	Description
id	ID du script de site à supprimer.

Exemples

Cet exemple supprime un script de site.

RestRequest("/_api/Microsoft.SharePoint.Utilities.WebTemplateExtensions.SiteScriptUtility.DeleteSiteScript",
{id:"07702c07-0485-426f-b710-4704241caad9"});

CreateSiteDesign

Crée une nouvelle conception de site accessible aux utilisateurs lorsqu’ils créent un site à partir de la page d’accueil SharePoint.

Paramètres

Paramètre	Description
id	ID de la conception de site à appliquer.
Titre	Nom d’affichage de la conception de site.
WebTemplate	Identifie le modèle de base auquel ajouter la conception. Utilisez la valeur 64 pour le modèle de site d’équipe et la valeur 68 pour le modèle de site de communication.
SiteScriptIds	Tableau d’un ou plusieurs scripts de site. Chacun d’entre eux est identifié par un ID. Les scripts sont exécutés dans l’ordre indiqué.
Description	(Facultatif) Description affichée de la conception de site.
PreviewImageUrl	(Facultatif) URL d’une image d’aperçu. Si aucune image n’est spécifiée, SharePoint utilise une image générique.
PreviewImageAltText	(Facultatif) La description du texte de remplacement de l'image de préversion pour l'accessibilité.
IsDefault	(Facultatif) Indique true si la conception de site est appliquée comme conception de site par défaut. Sinon, indique false. Pour obtenir plus d’informations, consultez la rubrique Personnaliser une conception de site par défaut.

Exemples

Voici un exemple de création d’une conception de site.

RestRequest("/_api/Microsoft.SharePoint.Utilities.WebTemplateExtensions.SiteScriptUtility.CreateSiteDesign",{
  info:{
    Title:"Contoso customer tracking",
    Description:"Creates customer list and applies standard theme",
    SiteScriptIds:["07702c07-0485-426f-b710-4704241caad9"],
    WebTemplate:"64",
    PreviewImageUrl: "https://contoso.sharepoint.com/SiteAssets/contoso-design.png",
    PreviewImageAltText: "Customer tracking site design theme"
    }
  });

Voici un exemple de référence JSON renvoyée après avoir appelé la commande CreateSiteDesign. Il contient l’ID de la nouvelle conception de site.

{
  "@odata.context": "https://contoso.sharepoint.com/_api/$metadata#Microsoft.SharePoint.Utilities.WebTemplateExtensions.SiteDesignMetadata",
  "Description": "Creates customer list and applies standard theme",
  "PreviewImageAltText": "Customer tracking site design theme",
  "PreviewImageUrl": "https://contoso.sharepoint.com/SiteAssets/contoso-design.png",
  "SiteScriptIds": [ "07702c07-0485-426f-b710-4704241caad9" ],
  "Title": "Contoso customer tracking",
  "WebTemplate": "64",
  "Id": "614f9b28-3e85-4ec9-a961-5971ea086cca",
  "Version": 1
}

ApplySiteDesign

Applique une conception de sites à une collection de sites existante.

Paramètres

Paramètre	Description
siteDesignId	ID de la conception de site à appliquer.
webUrl	URL de la collection de sites où vous voulez appliquer la conception de site.

Exemples

Voici l’exemple de l’application d’une conception de site à la collection de sites ProjectGo.

RestRequest("/_api/Microsoft.SharePoint.Utilities.WebTemplateExtensions.SiteScriptUtility.ApplySiteDesign", {"siteDesignId": "614f9b28-3e85-4ec9-a961-5971ea086cca", "webUrl":"https://contoso.sharepoint.com/sites/projectgo"});

AddSiteDesignTaskToCurrentWeb

Ajoute une tâche de conception de site sur le site web actuel à appeler de façon asynchrone.

Paramètres

Paramètre	Description
siteDesignId	ID de la conception de site à appliquer.

Exemples

Voici l’exemple de l’ajout d’une tâche de conception de site à la collection de sites ProjectGo.

RestRequest("/_api/Microsoft.SharePoint.Utilities.WebTemplateExtensions.SiteScriptUtility.AddSiteDesignTaskToCurrentWeb", {siteDesignId: "614f9b28-3e85-4ec9-a961-5971ea086cca"});

GetSiteDesigns

Obtient une liste d’informations sur les conceptions de site existantes.

Paramètres

Aucun.

Exemples

Cet exemple obtient toutes les conceptions de site.

RestRequest("/_api/Microsoft.SharePoint.Utilities.WebTemplateExtensions.SiteScriptUtility.GetSiteDesigns");

Voici un exemple de référence JSON renvoyée après avoir appelé la commande GetSiteDesigns.

{
  "@odata.context": "https://contoso.sharepoint.com/_api/$metadata#Collection(Microsoft.SharePoint.Utilities.WebTemplateExtensions.SiteDesignMetadata)",
  "value": [
    {
      "Description": "Tracks customer orders",
      "IsDefault": false,
      "PreviewImageAltText": null,
      "PreviewImageUrl": null,
      "SiteScriptIds": [ "6dfedb96-c090-44e3-875a-1c38032715fc" ],
      "Title": "customer orders",
      "WebTemplate": "64",
      "Id": "bbbd5740-ed97-461b-8b8e-e682f3fa167b",
      "Version": 1
    },
    {
      "Description": "Creates customer list and applies standard theme",
      "IsDefault": true,
      "PreviewImageAltText": "Customer tracking site design theme",
      "PreviewImageUrl": "https://contoso.sharepoint.com/SiteAssets/site_design.png",
      "SiteScriptIds": [ "07702c07-0485-426f-b710-4704241caad9" ],
      "Title": "Contoso customer tracking",
      "WebTemplate": "64",
      "Id": "614f9b28-3e85-4ec9-a961-5971ea086cca",
      "Version": 1
    }
  ]
}

GetSiteDesignMetadata

Obtient des informations sur une conception de site spécifique.

Paramètres

Paramètre	Description
id	ID de la conception de site sur laquelle vous souhaitez obtenir des informations.

Exemples

Cet exemple obtient des informations sur une conception de site spécifique via son ID.

RestRequest("/_api/Microsoft.SharePoint.Utilities.WebTemplateExtensions.SiteScriptUtility.GetSiteDesignMetadata",
{id:"614f9b28-3e85-4ec9-a961-5971ea086cca"});

Voici un exemple de référence JSON renvoyée après avoir appelé la commande GetSiteDesignMetadata.

{
  "@odata.context": "https://contoso.sharepoint.com/_api/$metadata#Microsoft.SharePoint.Utilities.WebTemplateExtensions.SiteDesignMetadata",
  "Description": "Creates customer list and applies standard theme",
  "IsDefault": true,
  "PreviewImageAltText": "Customer tracking site design theme",
  "PreviewImageUrl": "https://contoso.sharepoint.com/SiteAssets/site_design.png",
  "SiteScriptIds": [ "07702c07-0485-426f-b710-4704241caad9" ],
  "Title": "Contoso customer tracking",
  "WebTemplate": "64",
  "Id": "614f9b28-3e85-4ec9-a961-5971ea086cca",
  "Version": 1
}

UpdateSiteDesign

Met à jour une conception de site avec de nouvelles valeurs. Dans l’appel REST, tous les paramètres sont facultatifs à l’exception de l’ID du script de site.

Remarque

Si vous avez défini au préalable le paramètre IsDefault sur TRUE et que vous souhaitez conserver cette valeur, vous devez transmettre à nouveau ce paramètre (sinon, il sera réinitialisé et sa valeur sera définie sur FALSE).

Paramètres

Paramètre	Description
ID	ID de la conception de site à mettre à jour.
Titre	(Facultatif) Nouveau nom d’affichage de la conception de site mise à jour.
WebTemplate	(Facultatif) Nouveau modèle à ajouter à la conception de site. Utilisez la valeur 64 pour le modèle de site d’équipe et la valeur 68 pour le modèle de site de communication.
SiteScripts	(Facultatif) Nouveau tableau d’un ou de plusieurs scripts de site. Chacun d’entre eux est identifié par un ID. Les scripts sont exécutés dans l’ordre indiqué.
Description	(Facultatif) Nouvelle description affichée de la conception de site mise à jour.
PreviewImageUrl	(Facultatif) Nouvelle URL d’une image d’aperçu.
PreviewImageAltText	(Facultatif) La nouvelle description du texte de remplacement de l'image de préversion pour l'accessibilité.
IsDefault	(Facultatif) Indique true si la conception de site est appliquée comme conception de site par défaut. Sinon, indique false. Pour obtenir plus d’informations, consultez la rubrique Personnaliser une conception de site par défaut.

Exemples

Cet exemple met à jour chaque valeur sur une conception de site existante.

RestRequest("/_api/Microsoft.SharePoint.Utilities.WebTemplateExtensions.SiteScriptUtility.UpdateSiteDesign",
 {updateInfo:{
   Id:"614f9b28-3e85-4ec9-a961-5971ea086cca",
   Title:"Contoso customer site",
   Description:"Creates site with customer theme and list",
   SiteScriptIds:["6b2b79e4-5da3-4352-8565-42a896fabd57","2b997981-258b-4e1e-81ff-f6fbf7235a1f"],
   PreviewImageUrl:"https://contoso.sharepoint.com/SiteAssets/customer_site.png",
   PreviewImageAltText:"Customer site with list and theme",
   WebTemplate:"68",
   Version: 7,
   IsDefault: false}});

Voici un exemple de référence JSON renvoyée après avoir appelé la commande UpdateSiteDesign.

{
  "@odata.context": "https://contoso.sharepoint.com/_api/$metadata#Microsoft.SharePoint.Utilities.WebTemplateExtensions.SiteDesignMetadata",
  "Description": "Creates site with customer theme and list",
  "IsDefault": false,
  "PreviewImageAltText": "Customer site with list and theme",
  "PreviewImageUrl": "https://contoso.sharepoint.com/SiteAssets/customer_site.png",
  "SiteScriptIds": [ "6b2b79e4-5da3-4352-8565-42a896fabd57", "2b997981-258b-4e1e-81ff-f6fbf7235a1f" ],
  "Title": "Contoso customer site",
  "WebTemplate": "68",
  "Id": "614f9b28-3e85-4ec9-a961-5971ea086cca",
  "Version": 7
}

DeleteSiteDesign

Supprime une conception de site.

Paramètres

Paramètre	Description
id	ID de la conception de site à supprimer.

Exemples

Cet exemple supprime une conception de site.

RestRequest("/_api/Microsoft.SharePoint.Utilities.WebTemplateExtensions.SiteScriptUtility.DeleteSiteDesign",
{id:"f9e76746-5076-4bd2-bad3-e611c488fa85"});

GetSiteDesignRights

Obtient la liste des principaux ayant accès à une conception de site.

Paramètres

Paramètre	Description
id	ID de la conception de site pour obtenir des informations sur les autorisations.

Exemples

Cet exemple obtient les autorisations d’affichage pour une conception de site spécifique.

RestRequest("/_api/Microsoft.SharePoint.Utilities.WebTemplateExtensions.SiteScriptUtility.GetSiteDesignRights",
{id:"dc076f7b-6c15-4d76-8f85-948a17f5dd18"});

Voici un exemple de référence JSON renvoyée après avoir appelé la commande GetSiteDesignRights.

{
  "@odata.context": "https://contoso.sharepoint.com/_api/$metadata#SiteDesignPrincipals",
  "value": [
    {
      "@odata.type": "#Microsoft.SharePoint.Utilities.WebTemplateExtensions.SiteDesignPrincipal",
      "@odata.id": "https://contoso.sharepoint.com/_api/Microsoft.SharePoint.Utilities.WebTemplateExtensions.SiteDesignPrincipalfca62a9f-e43e-49a0-9139-6ae4df212859",
      "@odata.editLink": "Microsoft.SharePoint.Utilities.WebTemplateExtensions.SiteDesignPrincipalfca62a9f-e43e-49a0-9139-6ae4df212859",
      "DisplayName": "Nestor Wilke",
      "PrincipalName": "i:0#.f|membership|nestorw@contoso.onmicrosoft.com",
      "Rights": 1
    },
    {
      "@odata.type": "#Microsoft.SharePoint.Utilities.WebTemplateExtensions.SiteDesignPrincipal",
      "@odata.id": "https://contoso.sharepoint.com/_api/Microsoft.SharePoint.Utilities.WebTemplateExtensions.SiteDesignPrincipalce4cd6f6-553b-4a55-9364-1d39125be0ef",
      "@odata.editLink": "Microsoft.SharePoint.Utilities.WebTemplateExtensions.SiteDesignPrincipalce4cd6f6-553b-4a55-9364-1d39125be0ef",
      "DisplayName": "Patti Fernandez",
      "PrincipalName": "i:0#.f|membership|pattif@contoso.onmicrosoft.com",
      "Rights": 1
    }
  ]
}

GrantSiteDesignRights

Autorise un ou plusieurs principaux à accéder à une conception de site.

Paramètres

Paramètre	Description
id	ID de la conception de site pour laquelle les autorisations doivent être accordées.
principalNames	Tableau d’un ou de plusieurs principaux de sécurité pour lesquels les autorisations d’affichage doivent être accordées. Les principaux peuvent être des utilisateurs ou des groupes de sécurité à extension messagerie dans le formulaire « alias » ou « alias@<nom de domaine>.com »
grantedRights	Toujours défini sur 1. Cette valeur représente l’autorisation Afficher.

Exemples

Cet exemple accorde des autorisations d’affichage à une conception de site pour Nestor et Patti (utilisateurs fictifs chez Contoso).

RestRequest("/_api/Microsoft.SharePoint.Utilities.WebTemplateExtensions.SiteScriptUtility.GrantSiteDesignRights", {
  "id": "dc076f7b-6c15-4d76-8f85-948a17f5dd18",
  "principalNames": [ "NestorW@contoso.onmicrosoft.com", "PattiF@contoso.onmicrosoft.com" ],
  "grantedRights": 1
});

RevokeSiteDesignRights

Révoque l’accès d’un ou de plusieurs principaux à une conception de site.

Paramètres

Paramètre	Description
id	ID de la conception de site pour laquelle les autorisations doivent être révoquées.
principalNames	Tableau d’un ou de plusieurs principaux pour lesquels les autorisations d’affichage doivent être révoquées. Si les autorisations de tous les principaux sont révoquées sur la conception de site, la conception de site devient consultable par tout le monde.

Exemples

Cet exemple révoque les autorisations d’affichage d’une conception de site pour Patti (utilisatrice fictive chez Contoso).

RestRequest("/_api/Microsoft.SharePoint.Utilities.WebTemplateExtensions.SiteScriptUtility.RevokeSiteDesignRights",
{id:"5d4756e9-e1f5-42f7-afa7-5fa5aac170aa",
 principalNames:["PattiF@contoso.onmicrosoft.com"] });

Voir aussi

Présentation des conceptions de site et des scripts de site SharePoint

Partager via

API REST de conception de site et de script de site

Conditions préalables

Commandes REST

Créer une fonction pour envoyer des demandes REST

CreateSiteScript

Paramètres

Exemples

GetSiteScripts

Paramètres

Exemples

GetSiteScriptFromWeb

Paramètres

Exemples

GetSiteScriptFromList

Paramètres

Exemples

GetSiteScriptMetadata

Paramètres

Exemples

UpdateSiteScript

Paramètres

Exemples

DeleteSiteScript

Paramètres

Exemples

CreateSiteDesign

Paramètres

Exemples

ApplySiteDesign

Paramètres

Exemples

AddSiteDesignTaskToCurrentWeb

Paramètres

Exemples

GetSiteDesigns

Paramètres

Exemples

GetSiteDesignMetadata

Paramètres

Exemples

UpdateSiteDesign

Paramètres

Exemples

DeleteSiteDesign

Paramètres

Exemples

GetSiteDesignRights

Paramètres

Exemples

GrantSiteDesignRights

Paramètres

Exemples

RevokeSiteDesignRights

Paramètres

Exemples

Voir aussi

Ressources supplémentaires