Skip to content

Commit 7eeb4fe

Browse files
bcameron1231VesaJuvonen
authored andcommitted
Adding AddSiteDesignTaskToCurrentWeb endpoint (SharePoint#3235)
Adding the new AddSiteDesignTaskToCurrentWeb endpoint to the documentation. This is an alternative to ApplySiteDesign to support more than 30 actions in a site script.
1 parent e6a218c commit 7eeb4fe

File tree

1 file changed

+24
-2
lines changed

1 file changed

+24
-2
lines changed

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

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ The following REST commands are available for working with site designs and site
2828
- **DeleteSiteScript** – Deletes a site script.
2929
- **CreateSiteDesign** – Creates a site design.
3030
- **ApplySiteDesign** – Applies a site design to an existing site collection.
31+
- **AddSiteDesignTaskToCurrentWeb** – Adds a site design task on the current web.
3132
- **GetSiteDesigns** – Gets a list of information on existing site designs.
3233
- **GetSiteDesignMetadata** – Gets information about a specific site design.
3334
- **UpdateSiteDesign** – Updates a site design with new values.
@@ -315,7 +316,7 @@ Applies a site design to an existing site collection.
315316

316317
|Parameter | Description |
317318
|------------|--------------|
318-
| id | The ID of the site design to apply. |
319+
| siteDesignId | The ID of the site design to apply. |
319320
| webUrl | The URL of the site collection where you want to apply the site design. |
320321

321322
### Examples
@@ -326,6 +327,26 @@ Here's an example of applying a site design to the ProjectGo site collection.
326327
RestRequest("/_api/Microsoft.Sharepoint.Utilities.WebTemplateExtensions.SiteScriptUtility.ApplySiteDesign", {siteDesignId: "614f9b28-3e85-4ec9-a961-5971ea086cca", "webUrl":"https://contoso.microsoft.com/sites/projectgo"});
327328
```
328329

330+
## AddSiteDesignTaskToCurrentWeb
331+
332+
Adds a site design task on the current web to be invoked asynchronously.
333+
334+
### Parameters
335+
336+
|Parameter | Description |
337+
|------------|--------------|
338+
| siteDesignId | The ID of the site design to apply. |
339+
340+
341+
### Examples
342+
343+
Here's an example of adding a site design task to the ProjectGo site collection.
344+
345+
```javascript
346+
RestRequest("/_api/Microsoft.Sharepoint.Utilities.WebTemplateExtensions.SiteScriptUtility.AddSiteDesignTaskToCurrentWeb", {siteDesignId: "614f9b28-3e85-4ec9-a961-5971ea086cca"});
347+
```
348+
<br/>
349+
329350
## GetSiteDesigns
330351

331352
Gets a list of information about existing site designs.
@@ -413,6 +434,7 @@ Here is an example of the JSON returned after calling **GetSiteDesignMetadata**.
413434
"Version": 1
414435
}
415436
```
437+
<br/>
416438

417439
## UpdateSiteDesign
418440

@@ -585,4 +607,4 @@ RestRequest("/_api/Microsoft.Sharepoint.Utilities.WebTemplateExtensions.SiteScri
585607

586608
## See also
587609

588-
- [SharePoint site design and site script overview](site-design-overview.md)
610+
- [SharePoint site design and site script overview](site-design-overview.md)

0 commit comments

Comments
 (0)