REST-API von SharePoint-Websitedesigns und Websiteskripts
Die SharePoint REST-Schnittstelle eignet sich für grundlegende Erstellungs-, Lese-, Aktualisierungs- und Löschoperationen (CRUD-Operationen) für Websitedesigns und Websiteskripte.
Der REST-Dienst in SharePoint Online (sowie in lokalen Bereitstellungen von SharePoint 2016 und höher) erlaubt die Zusammenfassung mehrerer Anforderungen in einem einzigen Aufruf an den Service mittels der ODATA-Abfrageoption „$batch“. Einzelheiten und Links zu Codebeispielen finden Sie unter Durchführen von Batchanforderungen mit den REST-APIs.
Voraussetzungen
Lesen Sie vor der Umsetzung der Beispiele in diesem Artikel zunächst die folgenden Artikel:
- Grundlegendes zum SharePoint-REST-Dienst
- Ausführen grundlegender Vorgänge unter Verwendung von SharePoint-REST-Endpunkten
REST-Befehle
Für Websitedesigns und Websiteskripts stehen die folgenden REST-Befehle zur Verfügung:
- CreateSiteScript : Erstellt ein neues Websiteskript.
- GetSiteScripts : Ruft eine Liste von Informationen zu vorhandenen Websiteskripts ab.
- GetSiteScriptFromWeb : Erstellt die Websiteskriptsyntax aus einer vorhandenen SharePoint-Website.
- GetSiteScriptFromList : Erstellt die Websiteskriptsyntax aus einer vorhandenen SharePoint-Liste.
- GetSiteScriptMetadata : Ruft Informationen zu einem bestimmten Websiteskript ab.
- UpdateSiteScript: Aktualisierungen ein Websiteskript mit neuen Werten.
- DeleteSiteScript : Löscht ein Websiteskript.
- CreateSiteDesign : Erstellt ein Websitedesign.
- ApplySiteDesign : Wendet ein Websitedesign auf eine vorhandene Websitesammlung an.
- AddSiteDesignTaskToCurrentWeb : Fügt eine Websiteentwurfsaufgabe im aktuellen Web hinzu.
- GetSiteDesigns : Ruft eine Liste von Informationen zu vorhandenen Websitedesigns ab.
- GetSiteDesignMetadata : Ruft Informationen zu einem bestimmten Websiteentwurf ab.
- UpdateSiteDesign: Aktualisierungen ein Websitedesign mit neuen Werten.
- DeleteSiteDesign : Löscht ein Websitedesign.
- GetSiteDesignRights : Ruft eine Liste von Prinzipalen ab, die Zugriff auf einen Websiteentwurf haben.
- GrantSiteDesignRights : Gewährt Zugriff auf ein Websitedesign für einen oder mehrere Prinzipale.
- RevokeSiteDesignRights : Widerruft den Zugriff aus einem Websitedesign für einen oder mehrere Prinzipale.
Erstellen einer Funktion zum Senden von REST-Anforderungen
Zum Arbeiten mit der REST-API wird empfohlen, eine Hilfsfunktion für die REST-Aufrufe zu erstellen. Die folgende RestRequest-Funktion ruft die im url-Parameter angegebene REST-Methode auf und übergibt die weiteren Parameter 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);
}
CreateSiteScript
Erstellt ein neues Websiteskript.
Parameter
| Parameter | Beschreibung |
|---|---|
| Titel | Der Anzeigename des Websitedesigns. |
| Inhalt | JSON-Wert, der das Skript beschreibt. Weitere Informationen finden Sie unter JSON-Referenz. |
Beispiele
Im folgenden Beispiel wird ein neues Websiteskript erstellt, das ein benutzerdefiniertes Design anwendet.
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);
Nachfolgend sehen Sie ein Beispiel des JSON-Codes, der nach dem Aufrufen von CreateSiteScript zurückgegeben wird. Er enthält die ID des neuen Websiteskripts.
{
"@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
Abrufen einer Liste von Informationen zu allen vorhandenen Websiteskripts.
Parameter
Keine.
Beispiele
Im folgenden Beispiel werden die Websiteskriptinformationen für alle Websiteskripts abgerufen.
RestRequest("/_api/Microsoft.SharePoint.Utilities.WebTemplateExtensions.SiteScriptUtility.GetSiteScripts");
Nachfolgend sehen Sie ein Beispiel des JSON-Codes, der nach dem Aufrufen von GetSiteScripts zurückgegeben wird.
{
"@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
Abrufen der Websiteskriptsyntax für eine bestimmte SharePoint-Website.
Parameter
| Parameter | Beschreibung |
|---|---|
| webUrl | Die URL, die mit „HTTPS“ der Website beginnt, zum Abrufen eines Websiteskripts. |
| IncludeBranding | (Optional) „true“, wenn Branding extrahiert wird, andernfalls „false“. |
| IncludedLists | (Optional) Ein Array aus einer oder mehreren Listen. Jedes wird durch die Listen-URL identifiziert. |
| IncludeRegionalSettings | (Optional) „true“, wenn Regionaleinstellungen extrahiert werden; andernfalls „false“. |
| IncludeSiteExternalSharingCapability | (Optional) „true“, wenn externe Freigabefunktionen extrahiert werden; andernfalls „false“. |
| IncludeTheme | (Optional) „true“, wenn benutzerdefiniertes Design extrahiert wird, andernfalls „false“. |
| IncludeLinksToExportedItems | (Optional) „true“, wenn Navigationslinks extrahiert werden, andernfalls „false“. Wenn Sie Navigationslinks exportieren möchten, die auf Listen verweisen, muss auch die Liste in die Anforderung einbezogen werden. |
Hinweis
Bei Verwendung dieser API muss mindestens ein Parameter enthalten sein, andernfalls schlägt die Anforderung fehl.
Beispiele
Hier ist ein Beispiel für das Abrufen des JSON-Objekts eines Websiteskripts aus der Contoso-Websitesammlung.
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
}
});
Hier ist ein Beispiel für den JSON-Code, der nach dem Aufrufen von GetSiteScriptFromWeb zurückgegeben wird.
Hinweis
Das hier gezeigte Antwortobjekt wird möglicherweise zur besseren Lesbarkeit verkürzt.
{
"$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
Ruft die Syntax des Websiteskripts für eine bestimmte Liste ab.
Parameter
| Parameter | Beschreibung |
|---|---|
| listUrl | Die URL der Liste für den Abruf des Websiteskripts |
Beispiele
Hier ist ein Beispiel für das Abrufen des JSON-Objekts eines Websiteskripts aus der Contoso-Kundenliste.
RestRequest("/_api/Microsoft.SharePoint.Utilities.WebTemplateExtensions.SiteScriptUtility.GetSiteScriptFromList", {listUrl: "https://consoso.sharepoint.com/sites/projectgo/Lists/Contoso%20customer%20list"});
Nachfolgend sehen Sie ein Beispiel des JSON-Codes, der nach dem Aufrufen von GetSiteScriptFromList zurückgegeben wird.
{"@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
Abrufen von Informationen zu einem bestimmten Websiteskript. Es wird auch der JSON-Code des Skripts zurückgegeben.
Parameter
| Parameter | Beschreibung |
|---|---|
| id | Die ID des Websiteskripts, über das Informationen abgerufen werden sollen. |
RestRequest("/_api/Microsoft.SharePoint.Utilities.WebTemplateExtensions.SiteScriptUtility.GetSiteScriptMetadata",
{id:"07702c07-0485-426f-b710-4704241caad9"});
Beispiele
Nachfolgend sehen Sie ein Beispiel des JSON-Codes, der nach dem Aufrufen von GetSiteScriptMetadata zurückgegeben wird.
{
"@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
Aktualisieren eines Websiteskripts mit neuen Werten. In dem REST-Aufruf sind alle Parameter mit Ausnahme der Website-Skript-ID optional.
Parameter
| Parameter | Beschreibung |
|---|---|
| Id | Die ID des zu aktualisierenden Websiteskripts. |
| Titel | (Optional) Der neue Anzeigename des Websiteskripts. |
| Beschreibung | (Optional) Die neue Beschreibung des Websiteskripts. |
| Version | (Optional) Die neue Versionsnummer des Websiteskripts. |
| Inhalt | (Optional) Ein neues JSON-Skript, das die Skriptaktionen definiert. Weitere Informationen finden Sie unter JSON-Schema eines Websitedesigns. |
Beispiele
Nachfolgend finden Sie ein Beispiel des Aktualisierens eines vorhandenen Websiteskripts mit einem neuen JSON-Skript und neuen Werten.
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)}});
Nachfolgend sehen Sie ein Beispiel des JSON-Codes, der nach dem Aufrufen von UpdateSiteScript zurückgegeben wird.
{
"@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
Löschen eines Websiteskripts.
Parameter
| Parameter | Beschreibung |
|---|---|
| id | Die ID des zu löschenden Websiteskripts. |
Beispiele
Nachfolgend finden Sie ein Beispiel zum Löschen eines Websiteskripts.
RestRequest("/_api/Microsoft.SharePoint.Utilities.WebTemplateExtensions.SiteScriptUtility.DeleteSiteScript",
{id:"07702c07-0485-426f-b710-4704241caad9"});
CreateSiteDesign
Erstellen eines neues Websitedesigns, das für Benutzer beim Erstellen einer neuen Website von der SharePoint-Startseite verfügbar ist.
Parameter
| Parameter | Beschreibung |
|---|---|
| id | Die ID des zu anzuwendenden Websitedesigns. |
| Titel | Der Anzeigename des Websitedesigns. |
| WebTemplate | Identifiziert, zu welcher Basisvorlage das Design hinzugefügt werden soll. Verwenden Sie den Wert 64 für die Teamwebsite-Vorlage und den Wert 68 für die Kommunikationswebsitevorlage. |
| SiteScriptIds | Ein Array von einem oder mehreren Websiteskripts. Jedes wird durch eine ID identifziert. Die Skripts werden in der aufgeführten Reihenfolge ausgeführt. |
| Beschreibung | (Optional) Die Anzeigebeschreibung des Websitedesigns. |
| PreviewImageUrl | (Optional) Die URL eines Vorschaubilds. Wenn keine angegeben ist, verwendet SharePoint ein allgemeines Bild. |
| PreviewImageAltText | (Optional) Der alternative Text zur Beschreibung des Vorschaubilds für Barrierefreiheit. |
| IsDefault | (Optional) True, wenn das Websitedesign als Standarddesign der Website angewendet wird; andernfalls False. Weitere Informationen finden Sie unter Anpassen eines standardmäßigen Websitedesigns. |
Beispiele
Nachfolgend finden Sie ein Beispiel für das Erstellen eines neuen Websitedesigns.
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"
}
});
Nachfolgend sehen Sie ein Beispiel des JSON-Codes, der nach dem Aufrufen von CreateSiteDesign zurückgegeben wird. Er enthält die ID des neuen Websitedesigns.
{
"@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
Wendet ein Websitedesign auf eine vorhandene Websitesammlung an.
Parameter
| Parameter | Beschreibung |
|---|---|
| siteDesignId | Die ID des zu anzuwendenden Websitedesigns. |
| webUrl | Die URL der Websitesammlung, auf die das Websitedesign angewendet werden soll. |
Beispiele
Hier sehen Sie ein Bespiel für die Anwendung eines Websitedesigns auf die ProjectGo-Websitesammlung.
RestRequest("/_api/Microsoft.SharePoint.Utilities.WebTemplateExtensions.SiteScriptUtility.ApplySiteDesign", {"siteDesignId": "614f9b28-3e85-4ec9-a961-5971ea086cca", "webUrl":"https://contoso.sharepoint.com/sites/projectgo"});
AddSiteDesignTaskToCurrentWeb
Fügt eine Websitedesignaufgabe im aktuellen Web hinzu, die asynchron aufgerufen wird.
Parameter
| Parameter | Beschreibung |
|---|---|
| siteDesignId | Die ID des zu anzuwendenden Websitedesigns. |
Beispiele
Hier sehen Sie ein Bespiel für das Hinzufügen einer Websitedesignaufgabe zur ProjectGo-Websitesammlung.
RestRequest("/_api/Microsoft.SharePoint.Utilities.WebTemplateExtensions.SiteScriptUtility.AddSiteDesignTaskToCurrentWeb", {siteDesignId: "614f9b28-3e85-4ec9-a961-5971ea086cca"});
GetSiteDesigns
Abrufen einer Liste von Informationen zu vorhandenen Websitedesigns.
Parameter
Keine.
Beispiele
Nachfolgend finden Sie ein Beispiel zum Abrufen aller Websitedesigns.
RestRequest("/_api/Microsoft.SharePoint.Utilities.WebTemplateExtensions.SiteScriptUtility.GetSiteDesigns");
Nachfolgend sehen Sie ein Beispiel des JSON-Codes, der nach dem Aufrufen von GetSiteDesigns zurückgegeben wird.
{
"@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
Abrufen von Informationen zu einem bestimmten Websitedesign.
Parameter
| Parameter | Beschreibung |
|---|---|
| id | Die ID des Websitedesigns, über das Informationen abgerufen werden sollen. |
Beispiele
Nachfolgend finden Sie ein Beispiel zum Abrufen von Informationen zu einem bestimmten Websitedesign nach ID.
RestRequest("/_api/Microsoft.SharePoint.Utilities.WebTemplateExtensions.SiteScriptUtility.GetSiteDesignMetadata",
{id:"614f9b28-3e85-4ec9-a961-5971ea086cca"});
Nachfolgend sehen Sie ein Beispiel des JSON-Codes, der nach dem Aufrufen von GetSiteDesignMetadata zurückgegeben wird.
{
"@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
Aktualisieren eines Websitedesigns mit neuen Werten. In dem REST-Aufruf sind alle Parameter mit Ausnahme der Website-Skript-ID optional.
Hinweis
Wenn Sie zuvor den IsDefault-Parameter auf TRUE festgelegt haben und sie diese Einstellung beibehalten möchten, müssen Sie diesen Parameter erneut übergeben (andernfalls wird er auf FALSE zurückgesetzt).
Parameter
| Parameter | Beschreibung |
|---|---|
| Id | Die ID des zu aktualisierenden Websitedesigns. |
| Titel | (Optional) Der neue Anzeigename des aktualisierten Websitedesigns. |
| WebTemplate | (Optional) Die neue Vorlage, der das Websitedesign hinzugefügt werden soll. Verwenden Sie den Wert 64 für die Teamwebsite-Vorlage und den Wert 68 für die Kommunikationswebsitevorlage. |
| SiteScripts | (Optional) Ein neues Array von einem oder mehreren Websiteskripts. Jedes wird durch eine ID identifziert. Die Skripts werden in der aufgeführten Reihenfolge ausgeführt. |
| Beschreibung | (Optional) Die neue Anzeigebeschreibung des aktualisierten Websitedesigns. |
| PreviewImageUrl | (Optional) Die neue URL eines Vorschaubilds. |
| PreviewImageAltText | (Optional) Der neue alternative Text zur Beschreibung des Vorschaubilds für Barrierefreiheit. |
| IsDefault | (Optional) True, wenn das Websitedesign als Standarddesign der Website angewendet wird; andernfalls False. Weitere Informationen finden Sie unter Anpassen eines standardmäßigen Websitedesigns. |
Beispiele
Nachfolgend finden Sie ein Beispiel, in dem jeder Wert in einem vorhandenen Websitedesign aktualisiert wird.
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}});
Nachfolgend sehen Sie ein Beispiel des JSON-Codes, der nach dem Aufrufen von UpdateSiteDesign zurückgegeben wird.
{
"@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
Löscht ein Websitedesign.
Parameter
| Parameter | Beschreibung |
|---|---|
| id | Die ID des zu löschenden Websitedesigns. |
Beispiele
Nachfolgend finden Sie ein Beispiel zum Löschen eines Websitedesigns.
RestRequest("/_api/Microsoft.SharePoint.Utilities.WebTemplateExtensions.SiteScriptUtility.DeleteSiteDesign",
{id:"f9e76746-5076-4bd2-bad3-e611c488fa85"});
GetSiteDesignRights
Abrufen einer Liste von Prinzipalen, die Zugriff auf ein Websitedesign haben.
Parameter
| Parameter | Beschreibung |
|---|---|
| id | Die ID des Websitedesigns, über das Berechtigungsinformationen abgerufen werden sollen. |
Beispiele
Nachfolgend finden Sie ein Beispiel zum Abrufen der Anzeigeberechtigungen für ein bestimmtes Websitedesign.
RestRequest("/_api/Microsoft.SharePoint.Utilities.WebTemplateExtensions.SiteScriptUtility.GetSiteDesignRights",
{id:"dc076f7b-6c15-4d76-8f85-948a17f5dd18"});
Nachfolgend sehen Sie ein Beispiel des JSON-Codes, der nach dem Aufrufen von GetSiteDesignRights zurückgegeben wird.
{
"@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
Erteilen von Zugriff auf ein Websitedesign für einen oder mehrere Prinzipale.
Parameter
| Parameter | Beschreibung |
|---|---|
| id | Die ID des Websitedesigns, für das Berechtigungen gewährt werden sollen. |
| principalNames | Ein Array von einem oder mehreren Prinzipalen, denen Anzeigeberechtigungen gewährt werden sollen. Prinzipale können Benutzer oder E-Mail-aktivierte Sicherheitsgruppen in der Form „Alias“ oder „Alias@<Domänenname>.com“ sein. |
| grantedRights | Stets auf 1 festgelegt. Dies steht für die Berechtigung View. |
Beispiele
Nachfolgend ein Beispiel zum Erteilen von Anzeigerechten für ein Websitedesign für Nestor und Patti (fiktive Benutzer bei 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
Widerrufen des Zugriffs auf ein Websitedesign für einen oder mehrere Prinzipale.
Parameter
| Parameter | Beschreibung |
|---|---|
| id | Die ID des Websitedesigns, von dem Berechtigungen widerrufen werden sollen. |
| principalNames | Ein Array von einem oder mehreren Prinzipalen, von denen Anzeigeberechtigungen widerrufen werden sollen. Wenn für alle Prinzipale Berechtigungen für das Websitedesign widerrufen werden, ist die Seite für jeden sichtbar. |
Beispiele
Hier ist ein Beispiel zum Widerrufen von Ansichtsrechten aus einem Websitedesign für Patti (fiktiver Benutzer bei Contoso).
RestRequest("/_api/Microsoft.SharePoint.Utilities.WebTemplateExtensions.SiteScriptUtility.RevokeSiteDesignRights",
{id:"5d4756e9-e1f5-42f7-afa7-5fa5aac170aa",
principalNames:["PattiF@contoso.onmicrosoft.com"] });