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
+80-4Lines changed: 80 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
---
2
2
title: Site design JSON schema
3
3
description: JSON schema reference for building site designs for SharePoint.
4
-
ms.date: 05/25/2018
4
+
ms.date: 07/18/2018
5
5
---
6
6
7
7
# Site design JSON schema
@@ -133,7 +133,7 @@ Deletes a default field that was provided by the selected template type.
133
133
134
134
Enables defining fields and their elements using Collaborative Application Markup Language (CAML). For reference, see [Field element (Field)](https://docs.microsoft.com/en-us/sharepoint/dev/schema/field-element-field).
135
135
136
-
Currently these field constructs cannot be designated as site columns nor added to content types.
136
+
Currently these field constructs cannot be designated as site columns nor added to content types. To create site columns with Field XML use the **createSiteColumnXml** action.
137
137
138
138
#### JSON value
139
139
@@ -149,6 +149,27 @@ Currently these field constructs cannot be designated as site columns nor added
149
149
}
150
150
```
151
151
152
+
### addSPLookupFieldXml
153
+
154
+
Enables defining lookup fields and their dependent lists element using Collaborative Application Markup Language (CAML). For reference, see [Field element (Field)](https://docs.microsoft.com/en-us/sharepoint/dev/schema/field-element-field).
155
+
156
+
#### JSON value
157
+
158
+
-**schemaXml**– The CAML block to define the field.
159
+
-**targetListName**– The name that identifies the list this lookup field is referencing. Provide either this or targetListUrl.
160
+
-**targetListUrl**– A web-relative URL that identifies the list this lookup field is referencing. Provide either this or targetListName.
161
+
-**addToDefaultView**–**True** if the field will be added to the default view; otherwise, **false**.
Defines and adds a view to the list. Use this action to specify the desired columns and how you want the list items displayed (using a CAML query). Action properties allow you to specify row limits, and whether the view is paged and recurses over items in nested folders. You can also designate your constructed view as the default.
@@ -421,6 +442,23 @@ Use the **createSiteColumn** verb to define a new site column that can then be a
421
442
}
422
443
```
423
444
445
+
Use the **createSiteColumnXml** verb to define a new site column for those complex data types not supported by createSiteColumn. These columns can then be associated to a list directly or by using the addContentType action.
446
+
447
+
#### JSON value
448
+
449
+
-**schemaXml**– The CAML block to define the field.
450
+
-**pushChanges**– Indicates whether this change should be pushed to lists that already reference this field. Defaults to **true**.
Use **createContentType** to define a new content type that can then be associated to a list by using the addContentType action.
@@ -502,8 +540,6 @@ Subaction to remove a site column from a list or content type.
502
540
}
503
541
```
504
542
505
-
506
-
507
543
## Add a navigation link
508
544
509
545
Use the **addNavLink** verb to add a new navigation link to the site.
@@ -535,6 +571,46 @@ Use the **addNavLink** verb to add a new navigation link to the site.
535
571
}
536
572
```
537
573
574
+
## Remove a navigation link
575
+
576
+
Use the **removeNavLink** verb to remove a navigation link from the site.
577
+
578
+
#### JSON values
579
+
580
+
-**url**– The url of the link to add.
581
+
-**displayName**– The display name of the link.
582
+
-**isWebRelative**–**True** if the link is web relative; otherwise, **false**.
583
+
584
+
#### Example
585
+
586
+
> [!NOTE]
587
+
> This action can be used to remove site links added by the collaboration and communication site templates (for example, "home", "documents", "pages", "conversations", etc.).
Use the **applyTheme** verb to add a custom theme to the site. For more information about how to construct and upload these themes, see [SharePoint site theming](site-theming/sharepoint-site-theming-overview.md). Note that this site action only works for applying custom themes; to apply one of our in-product SharePoint themes, create a copy as a custom one and reference that one.
0 commit comments