网站设计和网站脚本 REST API

项目
04/08/2023

可以使用 SharePoint REST 接口对网站设计和网站脚本执行基本的创建、读取、更新和删除 (CRUD) 操作。

SharePoint Online（和本地 SharePoint 2016 及更高版本）REST 服务支持使用 OData $batch 查询选项，将多个请求合并到一个服务调用中。有关详细信息和代码示例链接，请参阅使用 REST API 发出批处理请求。

先决条件

开始前，请务必先熟悉以下内容：

REST 命令

下面的 REST 命令可用于处理网站设计和网站脚本：

CreateSiteScript – 创建新网站脚本。
GetSiteScripts – 获取有关现有网站脚本的信息列表。
GetSiteScriptFromWeb - 从现有 SharePoint 网站创建网站脚本语法。
GetSiteScriptFromList - 从现有 SharePoint 列表创建网站脚本语法。
GetSiteScriptMetadata – 获取有关特定站点脚本的信息。
UpdateSiteScript – 汇报具有新值的站点脚本。
DeleteSiteScript – 删除网站脚本。
CreateSiteDesign – 创建网站设计。
ApplySiteDesign - 将网站设计应用于现有网站集。
AddSiteDesignTaskToCurrentWeb – 在当前 Web 上添加网站设计任务。
GetSiteDesigns - 获取有关现有网站设计的信息列表。
GetSiteDesignMetadata – 获取有关特定网站设计的信息。
UpdateSiteDesign - 使用新值汇报网站设计。
DeleteSiteDesign – 删除网站设计。
GetSiteDesignRights – 获取有权访问网站设计的主体列表。
GrantSiteDesignRights – 授予一个或多个主体对网站设计的访问权限。
RevokeSiteDesignRights – 撤销一个或多个主体的网站设计的访问权限。

创建用于发送 REST 请求的函数

若要使用 REST API，建议创建用于执行 REST 调用的帮助程序函数。下面的 RestRequest 函数调用 url 参数中指定的 REST 方法，并在 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

新建网站脚本。

参数

参数	说明
Title	网站设计的显示名称。
Content	描述脚本的 JSON 值。有关详细信息，请参阅 JSON 参考。

示例

下面的示例展示了如何新建应用自定义主题的网站脚本。

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

下面的示例展示了调用 CreateSiteScript 后返回的 JSON。其中包含新网站脚本的 ID。

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

获取所有现有网站脚本相关信息的列表。

参数

无。

示例

下面的示例展示了如何获取所有网站脚本的网站脚本信息。

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

下面的示例展示了调用 GetSiteScripts 后返回的 JSON。

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

获取特定 SharePoint 网站的网站脚本语法。

参数

参数	说明
WebUrl	以网站的 HTTPS 开头的 url，可用于检索网站脚本。
IncludeBranding	（可选）如果将提取品牌打造，则为 True；否则为 False。
IncludedLists	（可选）包含一个或多个列表的数组。每个都由列表 url 标识。
IncludeRegionalSettings	（可选）如果将提取区域设置，则为 True；否则为 False。
IncludeSiteExternalSharingCapability	（可选）如果将提取外部共享功能，则为 True；否则为 False。
IncludeTheme	（可选）如果将提取自定义主题，则为 True；否则为 False。
IncludeLinksToExportedItems	（可选）如果将提取导航链接，则为 True；否则为 False。为了导出指向列表的导航链接，还需要在请求中包含列表。

注意

使用此 API 时，必须提供至少一个 include 参数，否则请求会失败。

示例

下面的示例展示了从 Contoso 网站集中检索网站脚本 JSON 对象。

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

下面的示例展示了调用 GetSiteScriptFromWeb 后返回的 JSON。

注意

为了提高可读性，可能缩短了此处显示的响应对象。

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

为特定列表获取网站脚本语法。

参数

参数	说明
listUrl	用于检索网站脚本的 url 列表

示例

下面的示例展示了从 Contoso 客户列表中检索网站脚本 JSON 对象。

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

下面的示例展示了调用 GetSiteScriptFromList 后返回的 JSON。

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

获取特定网站脚本的相关信息。它还返回脚本的 JSON。

参数

参数	说明
id	要获取其信息的网站脚本的 ID。

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

示例

下面的示例展示了调用 GetSiteScriptMetadata 后返回的 JSON。

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

使用新值更新网站脚本。在 REST 调用中，除网站脚本 ID 以外，所有参数都是可选的。

参数

参数	说明
Id	要更新的网站脚本的 ID。
标题	（可选）网站脚本的新显示名称。
说明	（可选）网站脚本的新说明。
Version	（可选）网站脚本的新版本号。
Content	（可选）定义脚本操作的新 JSON 脚本。有关详细信息，请参阅网站设计 JSON 架构。

示例

下面的示例展示了如何使用新 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)}});

下面的示例展示了调用 UpdateSiteScript 后返回的 JSON。

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

删除网站脚本。

参数

参数	说明
id	要删除的网站脚本的 ID。

示例

下面的示例展示了如何删除网站脚本。

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

CreateSiteDesign

当用户通过 SharePoint 起始页创建一个新网站时，创建可供他们使用的新网站设计。

参数

参数	说明
id	要应用的网站设计的 ID。
Title	网站设计的显示名称。
WebTemplate	指明要将设计添加到的基模板。若要添加到团队网站模板，请使用值 64；若要添加到通信网站模板，请使用值 68。
SiteScriptIds	包含一个或多个网站脚本的数组。每个脚本都由 ID 标识。脚本按列表中的顺序运行。
Description	（可选）网站设计的显示说明。
PreviewImageUrl	（可选）预览图像 URL。如果没有指定，SharePoint 使用通用图像。
PreviewImageAltText	（可选）辅助功能要求的预览图像替换文字说明。
IsDefault	（可选）如果将网站设计应用为默认网站设计，则为 True；否则为 false。有关详细信息，请参阅自定义默认网站设计。

示例

下面的示例展示了如何新建网站设计。

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

下面的示例展示了调用 CreateSiteDesign 后返回的 JSON。其中包含新网站设计的 ID。

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

将网站设计应用于现有网站集。

参数

参数	说明
siteDesignId	要应用的网站设计的 ID。
WebUrl	要向其中应用网站设计的网站集的 URL。

示例

下面的示例将网站设计应用于 ProjectGo 网站集。

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

AddSiteDesignTaskToCurrentWeb

在要异步调用的当前 Web 上添加网站设计任务。

参数

参数	说明
siteDesignId	要应用的网站设计的 ID。

示例

下面的示例将网站设计任务添加至 ProjectGo 网站集。

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

GetSiteDesigns

获取现有网站设计相关信息的列表。

参数

无。

示例

下面的示例展示了如何获取所有网站设计。

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

下面的示例展示了调用 GetSiteDesigns 后返回的 JSON。

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

获取特定网站设计的相关信息。

参数

参数	说明
id	要获取其信息的网站设计的 ID。

示例

下面的示例展示了如何按 ID 获取特定网站设计的相关信息。

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

下面的示例展示了调用 GetSiteDesignMetadata 后返回的 JSON。

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

使用新值更新网站设计。在 REST 调用中，除网站脚本 ID 以外，所有参数都是可选的。

注意

如果之前将 IsDefault 参数设置为 TRUE 并希望它仍然为 TRUE，则必须再次传递该参数（否则，它将被重置为 FALSE）。

参数

参数	说明
Id	要更新的网站设计的 ID。
标题	（可选）更新后的网站设计的新显示名称。
WebTemplate	（可选）要将网站设计添加到的新模板。若要添加到团队网站模板，请使用值 64；若要添加到通信网站模板，请使用值 68。
SiteScripts	（可选）包含一个或多个网站脚本的新数组。每个脚本都由 ID 标识。脚本按列表中的顺序运行。
说明	（可选）更新后的网站设计的新显示说明。
PreviewImageUrl	（可选）新预览图像 URL。
PreviewImageAltText	（可选）辅助功能要求的新预览图像替换文字说明。
IsDefault	（可选）如果将网站设计应用为默认网站设计，则为 True；否则为 false。有关详细信息，请参阅自定义默认网站设计。

示例

下面的示例展示了如何更新现有网站设计的所有值。

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

下面的示例展示了调用 UpdateSiteDesign 后返回的 JSON。

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

删除网站设计。

参数

参数	说明
id	要删除的网站设计的 ID。

示例

下面的示例展示了如何删除网站设计。

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

GetSiteDesignRights

获取有权访问网站设计的主体列表。

参数

参数	说明
id	获取其权限信息的网站设计的 ID。

示例

下面的示例展示了如何获取特定网站设计的查看权限信息。

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

下面的示例展示了调用 GetSiteDesignRights 后返回的 JSON。

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

向一个或多个主体授予对网站设计的访问权限。

参数

参数	说明
id	要向主体授予对其权限的网站设计的 ID。
principalNames	要向其授予查看权限的一个或多个主体的数组。主体可以是用户或启用邮件的安全组，格式为“alias”或“alias@<域名>.com”
grantedRights	始终设置为 1。这表示查看权限。

示例

下面的示例展示了如何向 Nestor 和 Patti（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

撤销一个或多个主体对网站设计的访问权限。

参数

参数	说明
id	要撤销主体对其权限的网站设计的 ID。
principalNames	要撤销其对网站设计的权限的一个或多个主体的数组。如果撤销了所有主体对网站设计的权限，那么网站设计会变成可供所有人查看。

示例

下面的示例展示了如何撤销 Patti（Contoso 中的虚构用户）对网站设计的查看权限。

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

另请参阅

SharePoint 网站设计和网站脚本概述