API REST de design e script de site

Artigo
04/08/2023

Você pode usar a interface REST do SharePoint para realizar operações básicas de criação, leitura, atualização e exclusão (CRUD) em designs e scripts de sites.

O serviço REST do SharePoint Online (e o SharePoint 2016 e posterior no local) dá suporte à combinação de várias solicitações em uma única chamada para o serviço, usando a opção de consulta $batch do OData. Para obter detalhes e links de amostras de código, confira Fazer solicitações em lote com APIs REST.

Pré-requisitos

Antes de começar, verifique se está familiarizado com o seguinte:

Comandos REST

Os seguintes comandos REST estão disponíveis para trabalhar com designs e scripts de sites:

CreateSiteScript – Cria um novo script de site.
GetSiteScripts – Obtém uma lista de informações sobre scripts de site existentes.
GetSiteScriptFromWeb – Cria sintaxe de script de site de um site do SharePoint existente.
GetSiteScriptFromList – Cria sintaxe de script de site de uma lista do SharePoint existente.
GetSiteScriptMetadata – Obtém informações sobre um script de site específico.
UpdateSiteScript – Atualizações um script de site com novos valores.
DeleteSiteScript – exclui um script de site.
CreateSiteDesign – Cria um design de site.
ApplySiteDesign – Aplica um design de site a uma coleção de sites existente.
AddSiteDesignTaskToCurrentWeb – Adiciona uma tarefa de design de site na Web atual.
GetSiteDesigns – Obtém uma lista de informações sobre designs de sites existentes.
GetSiteDesignMetadata – Obtém informações sobre um design de site específico.
UpdateSiteDesign – Atualizações um design de site com novos valores.
DeleteSiteDesign – exclui um design de site.
GetSiteDesignRights – Obtém uma lista de entidades de segurança que têm acesso a um design de site.
GrantSiteDesignRights – concede acesso a um design de site para uma ou mais entidades.
RevokeSiteDesignRights – revoga o acesso de um design de site para uma ou mais entidades.

Crie uma função para enviar solicitações REST

Para usar a API REST, recomendamos a criação de uma função de ajuda para fazer chamadas REST. A seguinte função RestRequest chama o método REST especificado no parâmetro url e transmite os parâmetros adicionais em 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

Cria um novo script de site.

Parâmetros

Parâmetro	Descrição
Título	O nome de exibição do design de site.
Conteúdo	Valor JSON que descreve o script. Confira mais informações na referência de JSON.

Exemplos

O exemplo a seguir cria um novo script de site que aplica um tema personalizado.

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

Veja um exemplo de JSON retornado após chamar o CreateSiteScript. Ele contém a ID do novo 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

Obtém uma lista de informações sobre todos os scripts de site existentes.

Parâmetros

Nenhum.

Exemplos

O exemplo a seguir obtém as informações de script de site para todos os scripts de site.

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

Veja um exemplo de JSON retornado após chamar o GetSiteScript.

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

Obtém a sintaxe de script do site de um site do SharePoint específico.

Parâmetros

Parâmetro	Descrição
webUrl	A URL que começa com HTTPS do site para recuperar o script do site.
IncludeBranding	(Opcional) Verdadeiro se a identidade visual for extraída; caso contrário, falso.
IncludedLists	(Opcional) Uma matriz de uma ou mais listas. Cada uma é identificada pela URL da lista.
IncludeRegionalSettings	(Opcional) Verdadeiro se as configurações regionais forem extraídas; caso contrário, falso.
IncludeSiteExternalSharingCapability	(Opcional) Verdadeiro se o recurso de compartilhamento externo for extraído; caso contrário, falso.
IncludeTheme	(Opcional) Verdadeiro se o tema personalizado for extraído; caso contrário, falso.
IncludeLinksToExportedItems	(Opcional) Verdadeiro se os links de navegação forem extraídos; caso contrário, falso. Para exportar links de navegação apontando para listas, a lista também precisa ser incluída na solicitação.

Observação

Pelo menos um incluir parâmetro deve ser fornecido ao usar esta API, caso contrário, a solicitação falhará.

Exemplos

Confira um exemplo de recuperação de um objeto JSON de script de site do conjunto de sites da 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
   }
});

Aqui está um exemplo de JSON retornado após chamar o GetSiteScriptFromWeb.

Observação

O objeto de resposta mostrado aqui pode ser reduzido para facilitar a leitura.

{
    "$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

Obtém a sintaxe do script do site para uma lista específica.

Parâmetros

Parâmetro	Descrição
ListUrl	A url da lista para recuperar o script de site

Exemplos

Veja um exemplo de recuperação de um objeto JSON de script do site na lista de clientes da Contoso.

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

Veja um exemplo de JSON retornado após chamar o 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

Obtém informações sobre um script de site específico. Também retorna o JSON do script.

Parâmetros

Parâmetro	Descrição
id	A ID do script de site para obter mais informações.

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

Exemplos

Veja um exemplo de JSON retornado após chamar o 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

Atualiza um script de site com novos valores. Na chamada REST, todos os parâmetros são opcionais, exceto a ID do script de site.

Parâmetros

Parâmetro	Descrição
Id	A ID do script de site a ser atualizada.
Título	(Opcional) O novo nome de exibição do script de site.
Descrição	(opcional) A nova descrição do script de site.
Versão	(opcional) O novo número de versão do script de site.
Conteúdo	(Opcional) Um novo script JSON que define as ações de script. Confira mais informações no Esquema JSON de design de site.

Exemplos

Veja um exemplo de atualização de um script de site existente com valores e script JSON novos.

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

Veja um exemplo de JSON retornado após chamar o 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

Exclui um script de site.

Parâmetros

Parâmetro	Descrição
id	A ID do script de site a ser excluído.

Exemplos

Veja um exemplo de exclusão de um script de site.

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

CreateSiteDesign

Cria um novo design de site, disponível para os usuários quando criarem um novo site na página inicial do SharePoint.

Parâmetros

Parâmetro	Descrição
id	A ID do design de site a ser aplicada.
Título	O nome de exibição do design de site.
WebTemplate	Identifica qual modelo de base adicionar ao design. Use o valor 64 para o modelo de site de equipe, e o valor 68 para o modelo de site de comunicação.
SiteScriptIds	Uma matriz de um ou mais scripts de site. Cada um é identificado por uma ID. Os scripts serão executados na ordem listada.
Descrição	(Opcional) A descrição da exibição do design de site.
PreviewImageUrl	(Opcional) A URL de uma imagem de visualização. Se não houver nenhuma especificada, o SharePoint usa uma imagem genérica.
PreviewImageAltText	(Opcional) A descrição do texto alternativo da imagem de visualização para acessibilidade.
IsDefault	(Opcional) True se o design de site for aplicado como o design de site padrão; caso contrário, false. Confira mais informações sobre como Personalizar um design de site padrão.

Exemplos

Veja aqui um exemplo de como criar um novo design 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"
    }
  });

Veja um exemplo de JSON retornado após chamar o CreateSiteDesign. Ele contém a ID do novo design 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

Aplica um design de site a um conjunto de sites existente.

Parâmetros

Parâmetro	Descrição
siteDesignId	A ID do design de site a ser aplicada.
webUrl	A URL do conjunto de sites em que você deseja aplicar o design de sites.

Exemplos

Veja um exemplo de aplicação de design de site ao conjunto 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

Adiciona uma tarefa de design de site na Web atual para ser invocada de forma assíncrona.

Parâmetros

Parâmetro	Descrição
siteDesignId	A ID do design de site a ser aplicada.

Exemplos

Veja um exemplo de adição de uma tarefa de design de site ao conjunto de sites ProjectGo.

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

GetSiteDesigns

Obtém uma lista de informações sobre designs de site existentes.

Parâmetros

Nenhum.

Exemplos

Veja um exemplo de obtenção de todos os designs de site.

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

Veja um exemplo de JSON retornado após chamar o GetSiteDesign.

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

Obtém informações sobre um design de site específico.

Parâmetros

Parâmetro	Descrição
id	A ID do design de site para obter mais informações.

Exemplos

Veja um exemplo de obtenção de informações sobre um design de site específico pela ID.

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

Veja um exemplo de JSON retornado após chamar o 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

Atualiza um design de site com novos valores. Na chamada REST, todos os parâmetros são opcionais, exceto a ID do script de site.

Observação

Se você definiu anteriormente o parâmetro IsDefault como TRUE e gostaria que permanecesse assim, você deve passar novamente no parâmetro (caso contrário, ele será redefinido como FALSE).

Parâmetros

Parâmetro	Descrição
Id	A ID do design de site a ser atualizada.
Título	(Opcional) O novo nome de exibição do design de site atualizado.
WebTemplate	(Opcional) O novo modelo ao qual adicionar o design de site. Use o valor 64 para o modelo de site de equipe, e o valor 68 para o modelo de site de comunicação.
SiteScripts	(Opcional) Uma nova matriz de um ou mais scripts de site. Cada um é identificado por uma ID. Os scripts são executados na ordem listada.
Descrição	(Opcional) A nova descrição de exibição do design de site atualizado.
PreviewImageUrl	(Opcional) A nova URL de uma imagem de visualização.
PreviewImageAltText	(Opcional) A nova descrição do texto alternativo da imagem de visualização para acessibilidade.
IsDefault	(Opcional) True se o design de site for aplicado como o design de site padrão; caso contrário, false. Confira mais informações sobre como Personalizar um design de site padrão.

Exemplos

Veja um exemplo que atualiza cada valor em um design de site existente.

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

Veja um exemplo de JSON retornado após chamar o 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

Exclui um design de site.

Parâmetros

Parâmetro	Descrição
id	A ID do design de site a ser excluído.

Exemplos

Veja um exemplo de exclusão de um design de site.

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

GetSiteDesignRights

Obtém uma lista de entidades de segurança que têm acesso a um design de site.

Parâmetros

Parâmetro	Descrição
id	A ID do design de site para obter informações sobre direitos.

Exemplos

Veja um exemplo de obtenção de direitos de visualização para um design de site específico.

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

Veja um exemplo de JSON retornado após chamar o 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

Concede acesso a um design de site para uma ou mais entidades de segurança.

Parâmetros

Parâmetro	Descrição
id	A ID do design de site para conceder direitos.
principalNames	Uma matriz de uma ou mais entidades de segurança para conceder direitos de visualização. As entidades de segurança podem ser usuários ou grupos de segurança habilitados para email na forma de "alias" ou "alias@<nomededomínio>.com"
grantedRights	Sempre definido para 1. Isso representa o direito de modo de exibição.

Exemplos

Aqui está um exemplo de concessão de direitos de exibição para um design de site para Nestor e Patti (usuários fictícios da 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

Revoga o acesso a um design de site de uma ou mais entidades de segurança.

Parâmetros

Parâmetro	Descrição
id	A ID do design de site de onde revogar os direitos.
principalNames	Uma matriz de uma ou mais entidades de segurança para revogar direitos de visualização. Se todos as entidades de segurança tiverem os direitos revogados no design de site, o design de site se tornará visível para todos.

Exemplos

Aqui está um exemplo de revogação de direitos de exibição de um design de site para Patti (usuário fictício da Contoso).

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

Confira também

Visão geral sobre design e script de sites do SharePoint

Compartilhar via

API REST de design e script de site

Pré-requisitos

Comandos REST

Crie uma função para enviar solicitações REST

CreateSiteScript

Parâmetros

Exemplos

GetSiteScripts

Parâmetros

Exemplos

GetSiteScriptFromWeb

Parâmetros

Exemplos

GetSiteScriptFromList

Parâmetros

Exemplos

GetSiteScriptMetadata

Parâmetros

Exemplos

UpdateSiteScript

Parâmetros

Exemplos

DeleteSiteScript

Parâmetros

Exemplos

CreateSiteDesign

Parâmetros

Exemplos

ApplySiteDesign

Parâmetros

Exemplos

AddSiteDesignTaskToCurrentWeb

Parâmetros

Exemplos

GetSiteDesigns

Parâmetros

Exemplos

GetSiteDesignMetadata

Parâmetros

Exemplos

UpdateSiteDesign

Parâmetros

Exemplos

DeleteSiteDesign

Parâmetros

Exemplos

GetSiteDesignRights

Parâmetros

Exemplos

GrantSiteDesignRights

Parâmetros

Exemplos

RevokeSiteDesignRights

Parâmetros

Exemplos

Confira também

Recursos adicionais