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-json-schema.md
+25-24Lines changed: 25 additions & 24 deletions
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
---
2
2
title: Site template JSON schema
3
3
description: JSON schema reference for building site templates for SharePoint.
4
-
ms.date: 01/27/2022
4
+
ms.date: 01/31/2022
5
5
ms.localizationpriority: high
6
6
---
7
7
@@ -35,27 +35,27 @@ The overall JSON structure is specified as follows:
35
35
Use the **createSPList** verb to create a new SharePoint list.
36
36
37
37
> [!NOTE]
38
-
> Once **createSPList** is applied on a site, runnning the **createSPList** with the same list name will act as an update to the existing list.
38
+
> Once **createSPList** is applied on a site, running the **createSPList** with the same list name will act as an update to the existing list.
39
39
40
40
### JSON values
41
41
42
42
-`listName`: The name of the list.
43
-
-`templateType`: Which template to apply to the list. Typically you would use value 100. The full list of template type values is documented in [SPListTemplateType enumeration](/previous-versions/office/sharepoint-server/ms413878(v=office.15)) - but the ones we currently support include:
43
+
-`templateType`: Which template to apply to the list. Typically, you would use value 100. The full list of template type values is documented in [SPListTemplateType enumeration](/previous-versions/office/sharepoint-server/ms413878(v=office.15)) - but the ones we currently support include:
44
44
45
45
| List Template Name | Enum |
46
46
|--------------|---------|
47
-
Generic List | 100
48
-
Document Library | 101
49
-
Survey | 102
50
-
Links | 103
51
-
Announcements | 104
52
-
Contacts | 105
53
-
Events | 106
54
-
Tasks | 107
55
-
Discussion Board | 108
56
-
PictureLibrary | 109
57
-
Site Pages | 119
58
-
Issue Tracking | 1100
47
+
|Generic List | 100|
48
+
|Document Library | 101|
49
+
|Survey | 102|
50
+
|Links | 103|
51
+
|Announcements | 104|
52
+
|Contacts | 105|
53
+
|Events | 106|
54
+
|Tasks | 107|
55
+
|Discussion Board | 108|
56
+
|PictureLibrary | 109|
57
+
|Site Pages | 119|
58
+
|Issue Tracking | 1100|
59
59
60
60
If you use 101 or 119 and reference the default names ("Documents" or "Site Pages"), you can modify the library created with the template. See example below.
61
61
-`subactions`: An array of actions that run in the order listed to create your list.
@@ -198,7 +198,7 @@ Subaction to add a previously defined site column directly to a list (existing o
198
198
#### JSON value
199
199
200
200
-`internalName`: The internal name of the site column to add.
201
-
-`addToDefaultView`: Optional attribute that defaults to false. If true, the newly added field will also be added to the default view.
201
+
-`addToDefaultView`: Optional attribute that defaults to **False**. If **True**, the newly added field will also be added to the default view.
202
202
203
203
#### Example
204
204
@@ -223,7 +223,7 @@ Defines and adds a view to the list. Use this action to specify the desired colu
223
223
-`isPaged`: Specifies whether the view is paged.
224
224
-`makeDefault`: If **True**, the view will be made the default for the list; otherwise, **False**.
225
225
-`scope`: An optional setting to specify the scope of the view. For more information, see [SPViewScope enumeration](/previous-versions/office/sharepoint-server/ms458474(v=office.15)).
226
-
-`formatterJSON`: An optional setting to specify the JSON formatting for the view
226
+
-`formatterJSON`: An optional setting to specify the JSON formatting for the view.
227
227
228
228
#### Example
229
229
@@ -617,13 +617,13 @@ Use the `addNavLink` verb to add a new navigation link to the site QuickLaunch o
617
617
618
618
#### JSON values
619
619
620
-
-`url`: The url of the link to add.
620
+
-`url`: The URL of the link to add.
621
621
-`displayName`: The display name of the link.
622
622
-`navComponent`: The component where to add the link, QuickLaunch, Hub, or Footer. The default is **QuickLaunch**.
623
623
-`isWebRelative`: **True** if the link is web relative; otherwise, **False**. The default is **False**.
624
624
-`parentDisplayName`: An optional parameter. If provided, it makes this navigation link a child (sub link) of the navigation link with this displayName. If both this and parentUrl are provided, it searches for a link that matches both to be the parent.
625
-
-`parentUrl`: An optional parameter. If provided, it makes this navigation link a child (sub link) of the navigation link with this url. If both this and parentDisplayName are provided, it searches for a link that matches both to be the parent.
626
-
-`isParentUrlWebRelative`: An optional parameter. **True** if the link is web relative; otherwise, **False**. The default is **False**.
625
+
-`parentUrl`: An optional parameter. If provided, it makes this navigation link a child (sub link) of the navigation link with this URL. If both this and parentDisplayName are provided, it searches for a link that matches both to be the parent.
626
+
-`isParentUrlWebRelative`: An optional parameter. **True** if the link is web relative; otherwise, **False**. The default value is **False**.
627
627
628
628
#### Example
629
629
@@ -670,15 +670,15 @@ Use the `removeNavLink` verb to remove a navigation link from the site.
670
670
671
671
#### JSON values
672
672
673
-
-`url`: The url of the link to remove.
673
+
-`url`: The URL of the link to remove.
674
674
-`displayName`: The display name of the link.
675
675
-`navComponent`: The component where to remove the link from, QuickLaunch, Hub, or Footer. The default is **QuickLaunch**.
676
676
-`isWebRelative`: **True** if the link is web relative; otherwise, **False**.
677
677
678
678
#### Example
679
679
680
680
> [!NOTE]
681
-
> This action can be used to remove site links added by the collaboration and communication site templates (for example, "home", "documents", "pages", "conversations", etc.).
681
+
> This action can be used to remove site links added by the collaboration and communication site templates (for example, "home", "documents", "pages", and "conversations").
682
682
683
683
```json
684
684
{
@@ -806,7 +806,7 @@ Use the `setSiteLogo` verb to specify a logo for your site.
806
806
807
807
#### JSON value
808
808
809
-
-`url`: The url of the logo image to use.
809
+
-`url`: The URL of the logo image to use.
810
810
811
811
#### Example
812
812
@@ -831,7 +831,8 @@ Use the `joinHubSite` verb to join the site to a designated hub site.
831
831
832
832
#### Example
833
833
834
-
> [!NOTE] To get the hubSiteId, sign in to a site by using the **Connect-PnPOnline** cmdlet, and then run:
834
+
> [!NOTE]
835
+
> To get the `hubSiteId`, sign in to a site by using the **Connect-PnPOnline** cmdlet, and then run:
0 commit comments