You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/declarative-customization/site-design-rest-api.md
+19-3Lines changed: 19 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -6,9 +6,6 @@ ms.date: 12/14/2017
6
6
7
7
# Site design and site script REST API
8
8
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
-
12
9
You can use the the SharePoint REST interface to perform basic create, read, update, and delete (CRUD) operations on site designs and site scripts.
13
10
14
11
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
28
25
-**UpdateSiteScript**— Updates a site script with new values.
29
26
-**DeleteSiteScript**— Deletes a site script.
30
27
-**CreateSiteDesign**— Creates a site design.
28
+
-**ApplySiteDesign**— Applies a site design to an existing site collection.
31
29
-**GetSiteDesigns**— Gets a list of information on existing site designs.
32
30
-**GetSiteDesignMetadata**— Gets information about a sepcific site design.
33
31
-**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
248
246
249
247
|Parameter | Description |
250
248
|-----------|--------------|
249
+
| id | The ID of the site design to apply. |
251
250
|Title | The display name of the site design. |
252
251
|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. |
253
252
|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
287
286
}
288
287
```
289
288
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.
0 commit comments