Skip to content

Commit a68d16f

Browse files
authored
Update site-design-rest-api.md
removed preview notice and added details for ApplySiteDesign command
1 parent 5440412 commit a68d16f

File tree

1 file changed

+19
-3
lines changed

1 file changed

+19
-3
lines changed

docs/declarative-customization/site-design-rest-api.md

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,6 @@ ms.date: 12/14/2017
66

77
# Site design and site script REST API
88

9-
> [!NOTE]
10-
> Site designs and site scripts are in preview and are subject to change. They are currently only supported for use in production environments in Targeted Release.
11-
129
You can use the the SharePoint REST interface to perform basic create, read, update, and delete (CRUD) operations on site designs and site scripts.
1310

1411
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. For details and links to code samples, see [Make batch requests with the REST APIs](../sp-add-ins/make-batch-requests-with-the-rest-apis.md).
@@ -28,6 +25,7 @@ The following REST commands are available for working with site designs and site
2825
- **UpdateSiteScript** — Updates a site script with new values.
2926
- **DeleteSiteScript** — Deletes a site script.
3027
- **CreateSiteDesign** — Creates a site design.
28+
- **ApplySiteDesign** — Applies a site design to an existing site collection.
3129
- **GetSiteDesigns** — Gets a list of information on existing site designs.
3230
- **GetSiteDesignMetadata** — Gets information about a sepcific site design.
3331
- **UpdateSiteDesign** — Updates a site design with new values.
@@ -248,6 +246,7 @@ Creates a new site design available to users when they create a new site from th
248246

249247
|Parameter | Description |
250248
|-----------|--------------|
249+
| id | The ID of the site design to apply. |
251250
|Title | The display name of the site design. |
252251
|WebTemplate | Identifies which base template to add the design to. Use the value **64** for the Team site template, and the value **68** for the Communication site template. |
253252
|SiteScripts | An array of one or more site scripts. Each is identified by an ID. The scripts will run in the order listed. |
@@ -287,6 +286,23 @@ Here is an example of the JSON returned after calling **CreateSiteDesign**. It c
287286
}
288287
```
289288

289+
## ApplySiteDesign
290+
291+
Applies a site design to an existing site collection.
292+
293+
### Parameters
294+
295+
|Parameter | Description |
296+
|------------|--------------|
297+
| id | The ID of the site design to apply. |
298+
| webUrl | The Url of the site collection where you want to apply the site design. |
299+
300+
Here's an example of applying a site design to the ProjectGo site collection.
301+
302+
```javascript
303+
RestRequest("/_api/Microsoft.Sharepoint.Utilities.WebTemplateExtensions.SiteScriptUtility.ApplySiteDesign", {siteDesignId: "614f9b28-3e85-4ec9-a961-5971ea086cca", "webUrl":"https://contoso.microsoft.com/sites/projectgo"});
304+
```
305+
290306
## GetSiteDesigns
291307

292308
Gets a list of information on existing site designs.

0 commit comments

Comments
 (0)