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
+11-9Lines changed: 11 additions & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -170,7 +170,8 @@ Gets the site script syntax for a specific SharePoint site.
170
170
| IncludeTheme | (Optional) True if custom theme will be extracted; otherwise false. |
171
171
| IncludeLinksToExportedItems | (Optional) True if navigation links will be extracted; otherwise false. In order to export navigation links pointing to lists, the list needs to be included in the request as well. |
172
172
173
-
>**Note:** At least one **include** parameter must be provided when using this API, otherwise request fails.
173
+
> [!NOTE]
174
+
> At least one **include** parameter must be provided when using this API, otherwise request fails.
Here is an example of the JSON returned after calling **GetSiteScriptFromWeb**.
197
198
198
-
>**Note:** The response object shown here might be shortened for readability.
199
+
> [!NOTE]
200
+
> The response object shown here might be shortened for readability.
199
201
200
202
```json
201
203
{
@@ -265,7 +267,7 @@ Here is an example of the JSON returned after calling **GetSiteScriptFromWeb**.
265
267
266
268
## GetSiteScriptFromList
267
269
268
-
Gets the site script syntax for a specific list
270
+
Gets the site script syntax for a specific list.
269
271
270
272
### Parameters
271
273
@@ -435,7 +437,7 @@ Creates a new site design available to users when they create a new site from th
435
437
|SiteScriptIds | An array of one or more site scripts. Each is identified by an ID. The scripts will run in the order listed. |
436
438
|Description | (Optional) The display description of site design. |
437
439
|PreviewImageUrl | (Optional) The URL of a preview image. If none is specified, SharePoint uses a generic image. |
438
-
|PreviewImageAltText | (Optional) The alt text description of the image for accessibility. |
440
+
|PreviewImageAltText | (Optional) The alt text description of the preview image for accessibility. |
439
441
|IsDefault | (Optional) **True** if the site design is applied as the default site design; otherwise, **false**. For more information see [Customize a default site design](customize-default-site-design.md). |
440
442
441
443
### Examples
@@ -518,7 +520,7 @@ Gets a list of information about existing site designs.
518
520
519
521
### Parameters
520
522
521
-
None
523
+
None.
522
524
523
525
### Examples
524
526
@@ -618,7 +620,7 @@ Updates a site design with new values. In the REST call, all parameters are opti
618
620
|SiteScripts | (Optional) A new array of one or more site scripts. Each is identified by an ID. The scripts run in the order listed. |
619
621
|Description | (Optional) The new display description of the updated site design. |
620
622
|PreviewImageUrl | (Optional) The new URL of a preview image. |
621
-
|PreviewImageAltText | (Optional) The new alt text description of the image for accessibility. |
623
+
|PreviewImageAltText | (Optional) The new alt text description of the preview image for accessibility. |
622
624
|IsDefault | (Optional) **True** if the site design is applied as the default site design; otherwise, **false**. For more information see [Customize a default site design](customize-default-site-design.md). |
623
625
624
626
### Examples
@@ -739,7 +741,7 @@ Grants access to a site design for one or more principals.
739
741
740
742
### Examples
741
743
742
-
Here's an example of granting view rights to a site design for Nestor and Patti (fictional users at Contoso.)
744
+
Here's an example of granting view rights to a site design for Nestor and Patti (fictional users at Contoso).
0 commit comments