API de REST de diseño de sitio y script de sitioSite design and site script REST API

Puede usar la interfaz de REST de SharePoint para realizar operaciones básicas de creación, lectura, actualización y eliminación (CRUD) en diseños de sitio y scripts de sitio.You can use the SharePoint REST interface to perform basic create, read, update, and delete (CRUD) operations on site designs and site scripts.

El servicio REST de SharePoint Online (y SharePoint 2016 o versiones posteriores locales) admite la combinación de varias solicitudes en una sola llamada al servicio mediante el uso de la opción de consulta $batch de OData.The SharePoint Online (and SharePoint 2016 and later on-premises) REST service supports combining multiple requests into a single call to the service by using the OData $batch query option. Para obtener información detallada y vínculos a los ejemplos de código, vea Realizar solicitudes de lote con las API de REST.For details and links to code samples, see Make batch requests with the REST APIs.

Requisitos previosPrerequisites

Antes de empezar, asegúrese de que está familiarizado con lo siguiente:Before you get started, make sure that you're familiar with the following:

Comandos de RESTREST commands

Los siguientes comandos de REST están disponibles para trabajar con diseños de sitio y scripts de sitio:The following REST commands are available for working with site designs and site scripts:

  • CreateSiteScript – Crea un nuevo script de sitio.CreateSiteScript – Creates a new site script.
  • GetSiteScripts – Obtiene una lista de datos sobre scripts de sitio existentes.GetSiteScripts – Gets a list of information on existing site scripts.
  • GetSiteScriptFromList – Crea la sintaxis del script de sitio a partir de una lista de SharePoint existente.GetSiteScriptFromList – Creates site script syntax from an existing SharePoint list.
  • GetSiteScriptMetadata – Obtiene información sobre un script de sitio específico.GetSiteScriptMetadata – Gets information about a specific site script.
  • UpdateSiteScript – Actualiza un script de sitio con valores nuevos.UpdateSiteScript – Updates a site script with new values.
  • DeleteSiteScript – Elimina un script de sitio.DeleteSiteScript – Deletes a site script.
  • CreateSiteDesign – Crea un diseño de sitio.CreateSiteDesign – Creates a site design.
  • ApplySiteDesign – Aplica un diseño de sitio a una colección de sitios existente.ApplySiteDesign – Applies a site design to an existing site collection.
  • AddSiteDesignTaskToCurrentWeb – Agrega una tarea de diseño de sitio en el sitio web actual.AddSiteDesignTaskToCurrentWeb – Adds a site design task on the current web.
  • GetSiteDesigns – Obtiene una lista de datos sobre diseños de sitio existentes.GetSiteDesigns – Gets a list of information on existing site designs.
  • GetSiteDesignMetadata: obtiene información sobre un diseño de sitio concreto.GetSiteDesignMetadata – Gets information about a specific site design.
  • UpdateSiteDesign – Actualiza un diseño de sitio con nuevos valores.UpdateSiteDesign – Updates a site design with new values.
  • DeleteSiteDesign – Elimina un diseño de sitio.DeleteSiteDesign – Deletes a site design.
  • GetSiteDesignRights – Obtiene una lista de entidades de seguridad que tienen acceso a un diseño de sitio.GetSiteDesignRights – Gets a list of principals that have access to a site design.
  • GrantSiteDesignRights – Concede acceso a un diseño de sitio para una o más entidades de seguridad.GrantSiteDesignRights – Grants access to a site design for one or more principals.
  • RevokeSiteDesignRights – Revoca el acceso de un diseño de sitio para una o más entidades de seguridad.RevokeSiteDesignRights – Revokes access from a site design for one or more principals.

Crear una función para enviar solicitudes de RESTCreate a function to send REST requests

Para trabajar con la API de REST, se recomienda crear una función auxiliar que realice las llamadas a REST.To work with the REST API, we recommend creating a helper function to make the REST calls. La siguiente función RestRequest realiza una llamada al método REST especificado en el parámetro url y pasa los parámetros adicionales en params.The following RestRequest function calls the REST method specified in the url parameter and passes the additional parameters in 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);
}

CreateSiteScriptCreateSiteScript

Crea un nuevo script de sitio.Creates a new site script.

ParámetrosParameters

ParámetroParameter DescripciónDescription
TitleTitle Nombre para mostrar del diseño de sitio.The display name of the site design.
ContentContent Valor JSON que describe el script.JSON value that describes the script. Para más información, vea Referencia de JSON.For more information, see JSON reference.

EjemplosExamples

En el ejemplo siguiente se crea un script de sitio que aplica un tema personalizado.The following example creates a new site script that applies a custom theme.

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);

A continuación, se incluye un ejemplo del JSON devuelto después de llamar a CreateSiteScript.Here is an example of the JSON returned after calling CreateSiteScript. Contiene el id. del nuevo script de sitio.It contains the ID of the new site script.

{
  "@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
}

GetSiteScriptsGetSiteScripts

Obtiene una lista de datos sobre todos los scripts de sitio existentes.Gets a list of information on all existing site scripts.

ParámetrosParameters

Ninguno.None.

EjemplosExamples

En el ejemplo siguiente se obtiene la información de script de sitio de todos los scripts de sitio.The following example gets the site script information for all site scripts.

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

Este es un ejemplo del JSON devuelto después de llamar a GetSiteScripts.Here is an example of the JSON returned after calling 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
    }
  ]
}

GetSiteScriptFromListGetSiteScriptFromList

Obtiene la sintaxis del script de sitio para una lista específicaGets the site script syntax for a specific list

ParámetrosParameters

ParámetroParameter DescripciónDescription
listUrllistUrl Dirección URL de la lista para recuperar el script de sitioThe url of the list to retrieve site script

EjemplosExamples

Este es un ejemplo de recuperación de un objeto JSON de script de sitio de la lista de clientes de Contoso.Here's an example of retrieving a site script JSON object from the Contoso customer list.

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

Este es un ejemplo del JSON devuelto después de llamar a GetSiteScriptFromList.Here is an example of the JSON returned after calling 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
    }
  ]
}"}

GetSiteScriptMetadataGetSiteScriptMetadata

Obtiene información sobre un script de sitio específico.Gets information about a specific site script. También devuelve el JSON del script.It also returns the JSON of the script.

ParámetrosParameters

ParámetroParameter DescripciónDescription
idid Identificador del script de sitio del que se obtiene información.The ID of the site script to get information about.
RestRequest("/_api/Microsoft.Sharepoint.Utilities.WebTemplateExtensions.SiteScriptUtility.GetSiteScriptMetadata",
{id:"07702c07-0485-426f-b710-4704241caad9"});

EjemplosExamples

Este es un ejemplo del JSON devuelto después de llamar a GetSiteScriptMetadata.Here is an example of the JSON returned after calling 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
}

UpdateSiteScriptUpdateSiteScript

Actualiza un script de sitio con nuevos valores.Updates a site script with new values. En la llamada REST, todos los parámetros son opcionales, excepto el identificador del script de sitio.In the REST call, all parameters are optional except the site script Id.

ParámetrosParameters

ParámetroParameter DescripciónDescription
IdId El id. del script de sitio que se actualizará.The ID of the site script to update.
TitleTitle (Opcional) Nuevo nombre para mostrar del script de sitio.(Optional) The new display name of the site script.
DescriptionDescription (Opcional) La nueva descripción del script de sitio.(Optional) The new description of the site script.
VersionVersion (Opcional) El nuevo número de versión del script de sitio.(Optional) The new version number of the site script.
ContentContent (Opcional) Nuevo script JSON que define las acciones de script.(Optional) A new JSON script defining the script actions. Para más información, vea Esquema JSON de diseño de sitio.For more information, see Site design JSON schema.

EjemplosExamples

Este es un ejemplo de cómo actualizar un script de sitio existente con un nuevo script JSON y nuevos valores.Here's an example of updating an existing site script with a new JSON script and values.

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)}});

A continuación, se incluye un ejemplo del JSON devuelto después de llamar a UpdateSiteScript.Here is an example of the JSON returned after calling 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
}

DeleteSiteScriptDeleteSiteScript

Elimina un script de sitio.Deletes a site script.

ParámetrosParameters

ParámetroParameter DescripciónDescription
idid Identificador del script de sitio que se elimina.The ID of the site script to delete.

EjemplosExamples

Este es un ejemplo de cómo eliminar un script de sitio.Here's an example of deleting a site script.

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

CreateSiteDesignCreateSiteDesign

Crea un diseño de sitio disponible para los usuarios al crear un sitio desde la página de inicio de SharePoint.Creates a new site design available to users when they create a new site from the SharePoint home page.

ParámetrosParameters

ParámetroParameter DescripciónDescription
idid El id. del diseño de sitio que se aplicará.The ID of the site design to apply.
TitleTitle Nombre para mostrar del diseño de sitio.The display name of the site design.
WebTemplateWebTemplate Identifica la plantilla base que se agregará al diseño.Identifies which base template to add the design to. Use el valor 64 para la plantilla de sitio de grupo, y el valor 68 para la plantilla de sitio de comunicación.Use the value 64 for the Team site template, and the value 68 for the Communication site template.
SiteScriptsSiteScripts Una matriz de uno o más scripts de sitio.An array of one or more site scripts. Cada uno se identifica por un id.Each is identified by an ID. Los scripts se ejecutarán en el orden en que aparezcan en la lista.The scripts will run in the order listed.
DescriptionDescription (Opcional) La descripción para mostrar del diseño de sitio.(Optional) The display description of site design.
PreviewImageUrlPreviewImageUrl (Opcional) Dirección URL de una imagen de vista previa.(Optional) The URL of a preview image. Si no se especifica ninguna, SharePoint usará una imagen genérica.If none is specified, SharePoint uses a generic image.
PreviewImageAltTextPreviewImageAltText (Opcional) La descripción del texto alternativo de la imagen para fines de accesibilidad.(Optional) The alt text description of the image for accessibility.
IsDefaultIsDefault (Opcional) Es True si el diseño de sitio se aplica como diseño del sitio predeterminado; en caso contrario, es false.(Optional) True if the site design is applied as the default site design; otherwise, false. Para más información, vea Personalizar un diseño de sitio predeterminado.For more information see Customize a default site design.

EjemplosExamples

Este es un ejemplo de cómo crear un diseño de sitio.Here's an example of creating a new site design.

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"
    }
  });

A continuación, se incluye un ejemplo del JSON devuelto después de llamar a CreateSiteDesign.Here is an example of the JSON returned after calling CreateSiteDesign. Contiene el id. del nuevo diseño de sitio.It contains the ID of the new site design.

{
  "@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
}

ApplySiteDesignApplySiteDesign

Aplica un diseño de sitio a una colección de sitios existente.Applies a site design to an existing site collection.

ParámetrosParameters

ParámetroParameter DescripciónDescription
siteDesignIdsiteDesignId El id. del diseño de sitio que se aplicará.The ID of the site design to apply.
webUrlwebUrl Dirección URL de la colección de sitios donde quiere que se aplique el diseño de sitio.The URL of the site collection where you want to apply the site design.

EjemplosExamples

Este es un ejemplo de cómo aplicar un diseño de sitio a la colección de sitios ProjectGo.Here's an example of applying a site design to the ProjectGo site collection.

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

AddSiteDesignTaskToCurrentWebAddSiteDesignTaskToCurrentWeb

Agrega una tarea de diseño de sitio en la web actual para invocarla de forma asincrónica.Adds a site design task on the current web to be invoked asynchronously.

ParámetrosParameters

ParámetroParameter DescripciónDescription
siteDesignIdsiteDesignId El id. del diseño de sitio que se aplicará.The ID of the site design to apply.

EjemplosExamples

Este es un ejemplo de cómo añadir una tarea de diseño de sitio a la colección de sitios ProjectGo.Here's an example of adding a site design task to the ProjectGo site collection.

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

GetSiteDesignsGetSiteDesigns

Obtiene una lista de datos sobre diseños de sitio existentes.Gets a list of information about existing site designs.

ParámetrosParameters

NingunoNone

EjemplosExamples

Este es un ejemplo de cómo obtener todos los diseños de sitio.Here's an example of getting all the site designs.

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

A continuación, se incluye un ejemplo del JSON devuelto después de llamar a GetSiteDesigns.Here is an example of the JSON returned after calling 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
    }
  ]
}

GetSiteDesignMetadataGetSiteDesignMetadata

Obtiene información sobre un diseño de sitio específico.Gets information about a specific site design.

ParámetrosParameters

ParámetroParameter DescripciónDescription
idid Identificador del diseño de sitio del que se obtiene información.The ID of the site design to get information about.

EjemplosExamples

Este es un ejemplo de cómo obtener información sobre el diseño de un sitio específico por identificador.Here's an example of getting information about a specific site design by ID.

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

A continuación, se incluye un ejemplo del JSON devuelto después de llamar a GetSiteDesignMetadata.Here is an example of the JSON returned after calling 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
}

UpdateSiteDesignUpdateSiteDesign

Actualiza un diseño de sitio con nuevos valores.Updates a site design with new values. En la llamada REST, todos los parámetros son opcionales, excepto el identificador del script de sitio.In the REST call, all parameters are optional except the site script Id.

Nota

Si estableció el parámetro IsDefault en TRUE y no quiere cambiarlo, tendrá que volver a pasar el parámetro; en caso contrario, se restablecerá en FALSE.If you had previously set the IsDefault parameter to TRUE and wish it to remain true, you must pass in this parameter again (otherwise it will be reset to FALSE).

ParámetrosParameters

ParámetroParameter DescripciónDescription
IdId El id. del diseño de sitio que se actualizará.The ID of the site design to update.
TitleTitle (Opcional) El nuevo nombre para mostrar del diseño de sitio actualizado.(Optional) The new display name of the updated site design.
WebTemplateWebTemplate (Opcional) La nueva plantilla que se agregará al diseño de sitio.(Optional) The new template to add the site design to. Use el valor 64 para la plantilla de sitio de grupo y el valor 68 para la plantilla de sitio de comunicación.Use the value 64 for the Team site template, and the value 68 for the Communication site template.
SiteScriptsSiteScripts (Opcional) Una nueva matriz de uno o más scripts de sitio.(Optional) A new array of one or more site scripts. Cada uno se identifica con un id.Each is identified by an ID. Los scripts se ejecutan en el orden en que aparecen en la lista.The scripts run in the order listed.
DescriptionDescription (Opcional) La nueva descripción para mostrar del diseño de sitio actualizado.(Optional) The new display description of the updated site design.
PreviewImageUrlPreviewImageUrl (Opcional) La nueva dirección URL de una imagen de vista previa.(Optional) The new URL of a preview image.
PreviewImageAltTextPreviewImageAltText (Opcional) La nueva descripción del texto alternativo de la imagen para fines de accesibilidad.(Optional) The new alt text description of the image for accessibility.
IsDefaultIsDefault (Opcional) Es True si el diseño de sitio se aplica como diseño del sitio predeterminado; en caso contrario, es false.(Optional) True if the site design is applied as the default site design; otherwise, false. Para más información, vea Personalizar un diseño de sitio predeterminado.For more information see Customize a default site design.

EjemplosExamples

Este es un ejemplo en el que se actualizan todos los valores de un diseño de sitio existente.Here's an example that updates every value on an existing site design.

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}});

A continuación, se incluye un ejemplo del JSON devuelto después de llamar a UpdateSiteDesign.Here is an example of the JSON returned after calling 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
}

DeleteSiteDesignDeleteSiteDesign

Elimina un diseño de sitio.Deletes a site design.

ParámetrosParameters

ParámetroParameter DescripciónDescription
idid Identificador del diseño de sitio que se elimina.The ID of the site design to delete.

EjemplosExamples

Este es un ejemplo de cómo eliminar un diseño de sitio.Here's an example of deleting a site design.

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

GetSiteDesignRightsGetSiteDesignRights

Obtiene una lista de entidades de seguridad que tienen acceso a un diseño de sitio.Gets a list of principals that have access to a site design.

ParámetrosParameters

ParámetroParameter DescripciónDescription
idid Identificador del diseño de sitio del que se obtiene información de derechos.The ID of the site design to get rights information from.

EjemplosExamples

Este es un ejemplo de cómo obtener derechos de visualización en un diseño de sitio específico.Here's an example of getting view rights for a specific site design.

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

A continuación, se incluye un ejemplo del JSON devuelto después de llamar a GetSiteDesignRights.Here is an example of the JSON returned after calling 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
    }
  ]
}

GrantSiteDesignRightsGrantSiteDesignRights

Concede acceso a un diseño de sitio para una o más entidades de seguridad.Grants access to a site design for one or more principals.

ParámetrosParameters

ParámetroParameter DescripciónDescription
idid El id. del diseño de sitio del que se concederán derechos.The ID of the site design to grant rights on.
principalNamesprincipalNames Una matriz de una o más entidades de seguridad a las que se conceden los derechos de visualización.An array of one or more principals to grant view rights. Las entidades de seguridad pueden ser usuarios o grupos de seguridad habilitados para correo electrónico. Se especifican con el formato "alias" o "alias@<nombre de dominio>.com".Principals can be users or mail-enabled security groups in the form of "alias" or "alias@<domain name>.com"
grantedRightsgrantedRights Siempre se establece en 1.Always set to 1. Representa el derecho de Visualización.This represents the View right.

EjemplosExamples

Este es un ejemplo en el que se conceden derechos de visualización a Íker y Elvira (usuarios ficticios de Contoso) en un diseño de sitio.Here's an example of granting view rights to a site design for Nestor and Patti (fictional users at 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
});

RevokeSiteDesignRightsRevokeSiteDesignRights

Revoca el acceso de un diseño de sitio para una o más entidades de seguridad.Revokes access from a site design for one or more principals.

ParámetrosParameters

ParámetroParameter DescripciónDescription
idid El id. del diseño de sitio del que se revocarán los derechos.The ID of the site design to revoke rights from.
principalNamesprincipalNames Una matriz de una o más entidades de seguridad a las que se revocarán los derechos de visualización.An array of one or more principals to revoke view rights from. Si se revocan los derechos de todas las entidades de seguridad en el diseño de sitio, este se vuelve visible para todos los usuarios.If all principals have rights revoked on the site design, the site design becomes viewable to everyone.

EjemplosExamples

Este es un ejemplo en el que se revocan los derechos de visualización de Elvira (usuario ficticio de Contoso) en un diseño de sitio.Here's an example of revoking view rights from a site design for Patti (fictional user at Contoso.)

RestRequest("/_api/Microsoft.Sharepoint.Utilities.WebTemplateExtensions.SiteScriptUtility.RevokeSiteDesignRights", 
{id:"5d4756e9-e1f5-42f7-afa7-5fa5aac170aa",
 principalNames:["debrab@Contoso.sharepoint.com"] });

Vea tambiénSee also