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
+12-12Lines changed: 12 additions & 12 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: 09/24/2021
4
+
ms.date: 01/27/2022
5
5
ms.localizationpriority: high
6
6
---
7
7
@@ -24,11 +24,11 @@ The overall JSON structure is specified as follows:
24
24
}
25
25
```
26
26
27
-
You can view - and reference - the latest schema here: https://developer.microsoft.com/json-schemas/sp/site-design-script-actions.schema.json
27
+
> [!TIP]
28
+
> You can view - and reference - the latest schema here: https://developer.microsoft.com/json-schemas/sp/site-design-script-actions.schema.json
28
29
29
-
#### Applying site temlpates multiple times
30
-
31
-
**Actions** can be run more than once on a site. Rerunning **actions** on the same site with the same parameters will result in an update to the existing schema and not duplication of schema.
30
+
> [!NOTE]
31
+
> **Actions** can be run more than once on a site. Rerunning **actions** on the same site with the same parameters will result in an update to the existing schema and not duplication of schema.
32
32
33
33
## Create a new SharePoint list
34
34
@@ -37,7 +37,7 @@ Use the **createSPList** verb to create a new SharePoint list.
37
37
> [!NOTE]
38
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.
39
39
40
-
####JSON values
40
+
### JSON values
41
41
42
42
-`listName`: The name of the list.
43
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:
@@ -152,7 +152,7 @@ Deletes a default field that was provided by the selected template type.
152
152
153
153
### addSPFieldXml
154
154
155
-
Enables defining fields and their elements using Collaborative Application Markup Language (CAML). For reference, see [Field element (Field)](https://docs.microsoft.com/sharepoint/dev/schema/field-element-field). Providing the ID attribute in the field schemaXml is important in order to prevent the field from being created multiple times if the script is run more than once.
155
+
Enables defining fields and their elements using Collaborative Application Markup Language (CAML). For reference, see [Field element (Field)](/sharepoint/dev/schema/field-element-field). Providing the ID attribute in the field schemaXml is important in order to prevent the field from being created multiple times if the script is run more than once.
156
156
157
157
Currently these field constructs can't be designated as site columns nor added to content types. To create site columns with Field XML, use the **createSiteColumnXml** action.
158
158
@@ -172,7 +172,7 @@ Currently these field constructs can't be designated as site columns nor added t
172
172
173
173
### addSPLookupFieldXml
174
174
175
-
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/sharepoint/dev/schema/field-element-field). Providing the ID attribute in the field schemaXml is important in order to prevent the field from being created multiple times if the script is run more than once.
175
+
Enables defining lookup fields and their dependent lists element using Collaborative Application Markup Language (CAML). For reference, see [Field element (Field)](/sharepoint/dev/schema/field-element-field). Providing the ID attribute in the field schemaXml is important in order to prevent the field from being created multiple times if the script is run more than once.
176
176
177
177
#### JSON value
178
178
@@ -218,7 +218,7 @@ Defines and adds a view to the list. Use this action to specify the desired colu
218
218
219
219
-`name`: The name of the view.
220
220
-`viewFields`: An array of the internal names of the fields in your view.
221
-
-`query`: A CAML query string that contains the `where` clause for the view's query. See [CAML schemas] (https://docs.microsoft.com/sharepoint/dev/schema/collaborative-application-markup-language-caml-schemas).
221
+
-`query`: A CAML query string that contains the `where` clause for the view's query. See [CAML schemas](/sharepoint/dev/schema/collaborative-application-markup-language-caml-schemas).
222
222
-`rowLimit`: The row limit of the view.
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**.
@@ -374,7 +374,7 @@ In this example, we are formatting a number column as a data bar.
374
374
375
375
### associateFieldCustomizer
376
376
377
-
Registers field extension for a list field. For more information on these client-side extensions, see [Build field customizer](https://docs.microsoft.com/sharepoint/dev/spfx/extensions/get-started/building-simple-field-customizer) tutorial.
377
+
Registers field extension for a list field. For more information on these client-side extensions, see [Build field customizer](/sharepoint/dev/spfx/extensions/get-started/building-simple-field-customizer) tutorial.
378
378
379
379
#### JSON values
380
380
@@ -873,10 +873,10 @@ Use the `associateExtension` action to register a deployed SharePoint Framework
873
873
#### JSON values
874
874
875
875
-`title`: The title of the extension in the App Catalog.
876
-
-`___location`: Used to specify the extension type. If its used to create commands, then where the command would be displayed; otherwise this should be set to ClientSideExtension.ApplicationCustomizer.
876
+
-`___location`: Used to specify the extension type. If it's used to create commands, then where the command would be displayed; otherwise this should be set to ClientSideExtension.ApplicationCustomizer.
877
877
-`clientSideComponentId`: The identifier (GUID) of the extension in the App Catalog. This property value can be found in the manifest.json file or in the elements.xml file.
878
878
-`clientSideComponentProperties`: An optional parameter, which can be used to provide properties for the extension instance.
879
-
-`registrationId`: An optional parameter, which indicates the type of the list the extension is associated to (if its a list extension).
879
+
-`registrationId`: An optional parameter, which indicates the type of the list the extension is associated to (if it's a list extension).
880
880
-`registrationType`: An optional parameter, which should be specified if the extension is associated with a list.
881
881
-`scope`: Indicates whether the extension is associated with a `Web` or a `Site`.
0 commit comments