@microsoft/sp-module-interfaces 1.21.0-beta.0 → 1.21.0-beta.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index-internal-beta.d.ts +15 -3
- package/dist/index-internal-public.d.ts +47 -2
- package/dist/index-internal.d.ts +15 -3
- package/lib-commonjs/index.js +31 -29
- package/lib-commonjs/manifestHelpers.js +22 -19
- package/lib-commonjs/manifestSchemaValidator.js +70 -84
- package/lib-commonjs/manifestSchemas/IAdaptiveCardExtensionManifest.js +5 -2
- package/lib-commonjs/manifestSchemas/IClientSideApplicationManifest.js +5 -2
- package/lib-commonjs/manifestSchemas/IClientSideAssemblyManifest.js +5 -2
- package/lib-commonjs/manifestSchemas/IClientSideComponentLoaderConfiguration.js +11 -3
- package/lib-commonjs/manifestSchemas/IClientSideComponentManifest.js +5 -2
- package/lib-commonjs/manifestSchemas/IClientSideExtensionManifest.js +5 -2
- package/lib-commonjs/manifestSchemas/IClientSideLibraryManifest.js +5 -2
- package/lib-commonjs/manifestSchemas/IClientSideManifestBase.js +10 -3
- package/lib-commonjs/manifestSchemas/IClientSideMultiVersionManifest.js +5 -2
- package/lib-commonjs/manifestSchemas/IClientSideWebPartManifest.js +62 -67
- package/lib-commonjs/manifestSchemas/ICommandSetExtensionManifest.js +5 -2
- package/lib-commonjs/manifestSchemas/IPrefabAppManifest.js +5 -2
- package/lib-commonjs/manifestSchemas/ManifestType.js +18 -13
- package/lib-commonjs/manifestSchemas/examples/application_1.manifest.js +24 -6
- package/lib-commonjs/manifestSchemas/examples/application_2.manifest.js +28 -7
- package/lib-commonjs/manifestSchemas/examples/application_3.manifest.js +22 -5
- package/lib-commonjs/manifestSchemas/examples/assembly_1.manifest.js +18 -4
- package/lib-commonjs/manifestSchemas/examples/commandSet_1.manifest.js +15 -3
- package/lib-commonjs/manifestSchemas/examples/extension_1.manifest.js +15 -3
- package/lib-commonjs/manifestSchemas/examples/extension_2.manifest.js +15 -3
- package/lib-commonjs/manifestSchemas/examples/extension_3.manifest.js +15 -3
- package/lib-commonjs/manifestSchemas/examples/extension_4.manifest.js +15 -3
- package/lib-commonjs/manifestSchemas/examples/library_1.manifest.js +18 -4
- package/lib-commonjs/manifestSchemas/examples/multi-version_1.manifest.js +24 -6
- package/lib-commonjs/manifestSchemas/examples/prefab_1.manifest.js +27 -7
- package/lib-commonjs/manifestSchemas/examples/prefab_2.manifest.js +61 -9
- package/lib-commonjs/manifestSchemas/examples/prefabapp.manifest.json +37 -3
- package/lib-commonjs/manifestSchemas/examples/webpart_1.manifest.js +24 -6
- package/lib-commonjs/manifestSchemas/examples/webpart_2.manifest.js +47 -12
- package/lib-commonjs/manifestSchemas/jsonSchemas/prefab-app-manifest.schema.json +107 -3
- package/{lib-commonjs → lib-dts}/manifestSchemaValidator.d.ts +1 -1
- package/{lib-commonjs → lib-dts}/manifestSchemas/IClientSideWebPartManifest.d.ts +1 -3
- package/lib-dts/manifestSchemas/IPrefabAppManifest.d.ts +255 -0
- package/{lib-commonjs → lib-dts}/manifestSchemas/examples/application_1.manifest.d.ts +1 -1
- package/{lib-commonjs → lib-dts}/manifestSchemas/examples/application_2.manifest.d.ts +1 -1
- package/{lib-commonjs → lib-dts}/manifestSchemas/examples/application_3.manifest.d.ts +1 -1
- package/{lib-commonjs → lib-dts}/manifestSchemas/examples/assembly_1.manifest.d.ts +1 -1
- package/{lib-commonjs → lib-dts}/manifestSchemas/examples/commandSet_1.manifest.d.ts +1 -1
- package/{lib-commonjs → lib-dts}/manifestSchemas/examples/extension_1.manifest.d.ts +1 -1
- package/{lib-commonjs → lib-dts}/manifestSchemas/examples/extension_2.manifest.d.ts +1 -1
- package/{lib-commonjs → lib-dts}/manifestSchemas/examples/extension_3.manifest.d.ts +1 -1
- package/{lib-commonjs → lib-dts}/manifestSchemas/examples/extension_4.manifest.d.ts +1 -1
- package/{lib-commonjs → lib-dts}/manifestSchemas/examples/library_1.manifest.d.ts +1 -1
- package/{lib-commonjs → lib-dts}/manifestSchemas/examples/multi-version_1.manifest.d.ts +1 -1
- package/{lib-commonjs → lib-dts}/manifestSchemas/examples/prefab_1.manifest.d.ts +1 -1
- package/{lib-commonjs → lib-dts}/manifestSchemas/examples/prefab_2.manifest.d.ts +1 -1
- package/{lib-commonjs → lib-dts}/manifestSchemas/examples/webpart_1.manifest.d.ts +1 -1
- package/{lib-commonjs → lib-dts}/manifestSchemas/examples/webpart_2.manifest.d.ts +1 -1
- package/{dist → lib-dts}/tsdoc-metadata.json +1 -1
- package/lib-esm/index.js +15 -0
- package/lib-esm/manifestHelpers.js +21 -0
- package/lib-esm/manifestSchemaValidator.js +135 -0
- package/lib-esm/manifestSchemas/IAdaptiveCardExtensionManifest.js +9 -0
- package/lib-esm/manifestSchemas/IClientSideApplicationManifest.js +5 -0
- package/lib-esm/manifestSchemas/IClientSideAssemblyManifest.js +7 -0
- package/lib-esm/manifestSchemas/IClientSideComponentLoaderConfiguration.js +17 -0
- package/lib-esm/manifestSchemas/IClientSideComponentManifest.js +27 -0
- package/lib-esm/manifestSchemas/IClientSideExtensionManifest.js +7 -0
- package/lib-esm/manifestSchemas/IClientSideLibraryManifest.js +7 -0
- package/lib-esm/manifestSchemas/IClientSideManifestBase.js +7 -0
- package/lib-esm/manifestSchemas/IClientSideMultiVersionManifest.js +25 -0
- package/lib-esm/manifestSchemas/IClientSideWebPartManifest.js +62 -0
- package/lib-esm/manifestSchemas/ICommandSetExtensionManifest.js +8 -0
- package/lib-esm/manifestSchemas/IPrefabAppManifest.js +7 -0
- package/lib-esm/manifestSchemas/ManifestType.js +15 -0
- package/lib-esm/manifestSchemas/examples/application.manifest.json +346 -0
- package/lib-esm/manifestSchemas/examples/application_1.manifest.js +344 -0
- package/lib-esm/manifestSchemas/examples/application_2.manifest.js +47 -0
- package/lib-esm/manifestSchemas/examples/application_3.manifest.js +42 -0
- package/lib-esm/manifestSchemas/examples/assembly.manifest.json +331 -0
- package/lib-esm/manifestSchemas/examples/assembly_1.manifest.js +336 -0
- package/lib-esm/manifestSchemas/examples/commandSet_1.manifest.js +42 -0
- package/lib-esm/manifestSchemas/examples/commandset.manifest.json +38 -0
- package/lib-esm/manifestSchemas/examples/extension.manifest.json +20 -0
- package/lib-esm/manifestSchemas/examples/extension_1.manifest.js +25 -0
- package/lib-esm/manifestSchemas/examples/extension_2.manifest.js +24 -0
- package/lib-esm/manifestSchemas/examples/extension_3.manifest.js +23 -0
- package/lib-esm/manifestSchemas/examples/extension_4.manifest.js +23 -0
- package/lib-esm/manifestSchemas/examples/library.manifest.json +330 -0
- package/lib-esm/manifestSchemas/examples/library_1.manifest.js +335 -0
- package/lib-esm/manifestSchemas/examples/multi-version_1.manifest.js +673 -0
- package/lib-esm/manifestSchemas/examples/multi-version_1.manifest.json +336 -0
- package/lib-esm/manifestSchemas/examples/prefab_1.manifest.js +344 -0
- package/lib-esm/manifestSchemas/examples/prefab_2.manifest.js +381 -0
- package/lib-esm/manifestSchemas/examples/prefabapp.manifest.json +379 -0
- package/lib-esm/manifestSchemas/examples/webpart.manifest.json +380 -0
- package/lib-esm/manifestSchemas/examples/webpart_1.manifest.js +350 -0
- package/lib-esm/manifestSchemas/examples/webpart_2.manifest.js +388 -0
- package/lib-esm/manifestSchemas/jsonSchemas/adaptive-card-extension-manifest.schema.json +230 -0
- package/lib-esm/manifestSchemas/jsonSchemas/any-value.schema.json +8 -0
- package/lib-esm/manifestSchemas/jsonSchemas/client-side-application-manifest.schema.json +138 -0
- package/lib-esm/manifestSchemas/jsonSchemas/client-side-assembly-manifest.schema.json +45 -0
- package/lib-esm/manifestSchemas/jsonSchemas/client-side-component-loader-configuration.schema.json +273 -0
- package/lib-esm/manifestSchemas/jsonSchemas/client-side-component-manifest.schema.json +131 -0
- package/lib-esm/manifestSchemas/jsonSchemas/client-side-extension-manifest.schema.json +61 -0
- package/lib-esm/manifestSchemas/jsonSchemas/client-side-library-manifest.schema.json +39 -0
- package/lib-esm/manifestSchemas/jsonSchemas/client-side-manifest-base.schema.json +25 -0
- package/lib-esm/manifestSchemas/jsonSchemas/client-side-multi-version-manifest.schema.json +118 -0
- package/lib-esm/manifestSchemas/jsonSchemas/client-side-web-part-manifest.schema.json +348 -0
- package/lib-esm/manifestSchemas/jsonSchemas/command-set-extension-manifest.schema.json +81 -0
- package/lib-esm/manifestSchemas/jsonSchemas/guid.schema.json +6 -0
- package/lib-esm/manifestSchemas/jsonSchemas/localized-string.schema.json +33 -0
- package/lib-esm/manifestSchemas/jsonSchemas/prefab-app-manifest.schema.json +176 -0
- package/lib-esm/manifestSchemas/jsonSchemas/semver.schema.json +8 -0
- package/lib-esm/manifestSchemas/remote/draft-04.schema.json +137 -0
- package/lib-esm/manifestSchemas/remote/site-design-script-actions.schema.json +1158 -0
- package/package.json +27 -7
- package/lib-commonjs/index.d.ts.map +0 -1
- package/lib-commonjs/manifestHelpers.d.ts.map +0 -1
- package/lib-commonjs/manifestSchemaValidator.d.ts.map +0 -1
- package/lib-commonjs/manifestSchemas/IAdaptiveCardExtensionManifest.d.ts.map +0 -1
- package/lib-commonjs/manifestSchemas/IClientSideApplicationManifest.d.ts.map +0 -1
- package/lib-commonjs/manifestSchemas/IClientSideAssemblyManifest.d.ts.map +0 -1
- package/lib-commonjs/manifestSchemas/IClientSideComponentLoaderConfiguration.d.ts.map +0 -1
- package/lib-commonjs/manifestSchemas/IClientSideComponentManifest.d.ts.map +0 -1
- package/lib-commonjs/manifestSchemas/IClientSideExtensionManifest.d.ts.map +0 -1
- package/lib-commonjs/manifestSchemas/IClientSideLibraryManifest.d.ts.map +0 -1
- package/lib-commonjs/manifestSchemas/IClientSideManifestBase.d.ts.map +0 -1
- package/lib-commonjs/manifestSchemas/IClientSideMultiVersionManifest.d.ts.map +0 -1
- package/lib-commonjs/manifestSchemas/IClientSideWebPartManifest.d.ts.map +0 -1
- package/lib-commonjs/manifestSchemas/ICommandSetExtensionManifest.d.ts.map +0 -1
- package/lib-commonjs/manifestSchemas/IPrefabAppManifest.d.ts +0 -76
- package/lib-commonjs/manifestSchemas/IPrefabAppManifest.d.ts.map +0 -1
- package/lib-commonjs/manifestSchemas/ManifestType.d.ts.map +0 -1
- package/lib-commonjs/manifestSchemas/examples/application_1.manifest.d.ts.map +0 -1
- package/lib-commonjs/manifestSchemas/examples/application_2.manifest.d.ts.map +0 -1
- package/lib-commonjs/manifestSchemas/examples/application_3.manifest.d.ts.map +0 -1
- package/lib-commonjs/manifestSchemas/examples/assembly_1.manifest.d.ts.map +0 -1
- package/lib-commonjs/manifestSchemas/examples/commandSet_1.manifest.d.ts.map +0 -1
- package/lib-commonjs/manifestSchemas/examples/extension_1.manifest.d.ts.map +0 -1
- package/lib-commonjs/manifestSchemas/examples/extension_2.manifest.d.ts.map +0 -1
- package/lib-commonjs/manifestSchemas/examples/extension_3.manifest.d.ts.map +0 -1
- package/lib-commonjs/manifestSchemas/examples/extension_4.manifest.d.ts.map +0 -1
- package/lib-commonjs/manifestSchemas/examples/library_1.manifest.d.ts.map +0 -1
- package/lib-commonjs/manifestSchemas/examples/multi-version_1.manifest.d.ts.map +0 -1
- package/lib-commonjs/manifestSchemas/examples/prefab_1.manifest.d.ts.map +0 -1
- package/lib-commonjs/manifestSchemas/examples/prefab_2.manifest.d.ts.map +0 -1
- package/lib-commonjs/manifestSchemas/examples/webpart_1.manifest.d.ts.map +0 -1
- package/lib-commonjs/manifestSchemas/examples/webpart_2.manifest.d.ts.map +0 -1
- /package/{lib-commonjs → lib-dts}/index.d.ts +0 -0
- /package/{lib-commonjs → lib-dts}/manifestHelpers.d.ts +0 -0
- /package/{lib-commonjs → lib-dts}/manifestSchemas/IAdaptiveCardExtensionManifest.d.ts +0 -0
- /package/{lib-commonjs → lib-dts}/manifestSchemas/IClientSideApplicationManifest.d.ts +0 -0
- /package/{lib-commonjs → lib-dts}/manifestSchemas/IClientSideAssemblyManifest.d.ts +0 -0
- /package/{lib-commonjs → lib-dts}/manifestSchemas/IClientSideComponentLoaderConfiguration.d.ts +0 -0
- /package/{lib-commonjs → lib-dts}/manifestSchemas/IClientSideComponentManifest.d.ts +0 -0
- /package/{lib-commonjs → lib-dts}/manifestSchemas/IClientSideExtensionManifest.d.ts +0 -0
- /package/{lib-commonjs → lib-dts}/manifestSchemas/IClientSideLibraryManifest.d.ts +0 -0
- /package/{lib-commonjs → lib-dts}/manifestSchemas/IClientSideManifestBase.d.ts +0 -0
- /package/{lib-commonjs → lib-dts}/manifestSchemas/IClientSideMultiVersionManifest.d.ts +0 -0
- /package/{lib-commonjs → lib-dts}/manifestSchemas/ICommandSetExtensionManifest.d.ts +0 -0
- /package/{lib-commonjs → lib-dts}/manifestSchemas/ManifestType.d.ts +0 -0
|
@@ -0,0 +1,1158 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
3
|
+
"title": "JSON Schema for SiteScript Extensions",
|
|
4
|
+
"definitions": {
|
|
5
|
+
"activateSPFeature": {
|
|
6
|
+
"type": "object",
|
|
7
|
+
"properties": {
|
|
8
|
+
"verb": {
|
|
9
|
+
"type": "string",
|
|
10
|
+
"pattern": "^activateSPFeature$"
|
|
11
|
+
},
|
|
12
|
+
"featureId": {
|
|
13
|
+
"type": "string",
|
|
14
|
+
"description": "The Guid of the feature to activate."
|
|
15
|
+
},
|
|
16
|
+
"scope": {
|
|
17
|
+
"type": "string",
|
|
18
|
+
"enum": ["web", "site"],
|
|
19
|
+
"description": "The scope of the feature to activate."
|
|
20
|
+
}
|
|
21
|
+
},
|
|
22
|
+
"required": ["featureId", "verb"]
|
|
23
|
+
},
|
|
24
|
+
"addContentTypesFromHub": {
|
|
25
|
+
"type": "object",
|
|
26
|
+
"properties": {
|
|
27
|
+
"verb": {
|
|
28
|
+
"type": "string",
|
|
29
|
+
"pattern": "^addContentTypesFromHub$"
|
|
30
|
+
},
|
|
31
|
+
"ids": {
|
|
32
|
+
"type": "array",
|
|
33
|
+
"description": "Optional parameter. If provided, an array of content type ids indicating the content types to be synced from the content type hub. If not provided, this action will sync all content types from the content type hub",
|
|
34
|
+
"items": [
|
|
35
|
+
{
|
|
36
|
+
"type": "string",
|
|
37
|
+
"description": "The content type id"
|
|
38
|
+
}
|
|
39
|
+
]
|
|
40
|
+
}
|
|
41
|
+
},
|
|
42
|
+
"required": ["verb"],
|
|
43
|
+
"additionalProperties": false
|
|
44
|
+
},
|
|
45
|
+
"associateExtension": {
|
|
46
|
+
"type": "object",
|
|
47
|
+
"properties": {
|
|
48
|
+
"verb": {
|
|
49
|
+
"type": "string",
|
|
50
|
+
"pattern": "^associateExtension$"
|
|
51
|
+
},
|
|
52
|
+
"title": {
|
|
53
|
+
"type": "string",
|
|
54
|
+
"description": "Title of the extension."
|
|
55
|
+
},
|
|
56
|
+
"location": {
|
|
57
|
+
"type": "string",
|
|
58
|
+
"pattern": "^ClientSideExtension\\..*$",
|
|
59
|
+
"description": "If this extension creates commands, where the commands are display. Otherwise, this should be set to ClientSideExtension.ApplicationCustomizer."
|
|
60
|
+
},
|
|
61
|
+
"clientSideComponentId": {
|
|
62
|
+
"type": "string",
|
|
63
|
+
"description": "GUID of the extension."
|
|
64
|
+
},
|
|
65
|
+
"clientSideComponentProperties": {
|
|
66
|
+
"type": "string",
|
|
67
|
+
"description": "This is an optional parameter, which can be used to provide properties for the instance."
|
|
68
|
+
},
|
|
69
|
+
"registrationId": {
|
|
70
|
+
"type": "string",
|
|
71
|
+
"description": "This is an optional parameter, which indicates the type of the list to which extension is associated, if the extension is associated with lists."
|
|
72
|
+
},
|
|
73
|
+
"registrationType": {
|
|
74
|
+
"type": "string",
|
|
75
|
+
"pattern": "^$|^List$",
|
|
76
|
+
"description": "This is an optional parameter, which should be specified if the extension is associated with a list."
|
|
77
|
+
},
|
|
78
|
+
"scope": {
|
|
79
|
+
"type": "string",
|
|
80
|
+
"pattern": "^(Web|Site)$",
|
|
81
|
+
"description": "Indicates whether the extension is associated with a Web or a Site."
|
|
82
|
+
}
|
|
83
|
+
},
|
|
84
|
+
"required": ["clientSideComponentId", "title", "location", "verb", "scope"],
|
|
85
|
+
"additionalProperties": false
|
|
86
|
+
},
|
|
87
|
+
"createSPList": {
|
|
88
|
+
"type": "object",
|
|
89
|
+
"properties": {
|
|
90
|
+
"verb": {
|
|
91
|
+
"type": "string",
|
|
92
|
+
"pattern": "^createSPList$"
|
|
93
|
+
},
|
|
94
|
+
"listName": {
|
|
95
|
+
"type": "string",
|
|
96
|
+
"description": "An identifying name for the list."
|
|
97
|
+
},
|
|
98
|
+
"templateType": {
|
|
99
|
+
"type": "number",
|
|
100
|
+
"description": "Specifies the type of a list definition or a list template."
|
|
101
|
+
},
|
|
102
|
+
"addNavLink": {
|
|
103
|
+
"type": "boolean",
|
|
104
|
+
"description": "Add a link to this list into the Quicklaunch using this list's title."
|
|
105
|
+
},
|
|
106
|
+
"hidden": {
|
|
107
|
+
"type": "boolean",
|
|
108
|
+
"description": "Optional attribute that defaults to false. If true, the list created will be hidden."
|
|
109
|
+
},
|
|
110
|
+
"color": {
|
|
111
|
+
"type": "string",
|
|
112
|
+
"description": "Optional attribute that specifies the list color."
|
|
113
|
+
},
|
|
114
|
+
"icon": {
|
|
115
|
+
"type": "string",
|
|
116
|
+
"description": "Optional attribute that specifies the list icon."
|
|
117
|
+
},
|
|
118
|
+
"fieldRefsXml": {
|
|
119
|
+
"type": "array",
|
|
120
|
+
"description": "Optional list of FieldRefs.",
|
|
121
|
+
"items": {
|
|
122
|
+
"type": "string"
|
|
123
|
+
}
|
|
124
|
+
},
|
|
125
|
+
"output": {
|
|
126
|
+
"type": "object",
|
|
127
|
+
"description": "Optional parameter. Used to bind list properties to run parameters.",
|
|
128
|
+
"properties": {
|
|
129
|
+
"webRelativeUrl": {
|
|
130
|
+
"type": "string",
|
|
131
|
+
"description": "Optional parameter. If provided, the web-relative url of the list will be bound to the provided run parameter label."
|
|
132
|
+
},
|
|
133
|
+
"absoluteUrl": {
|
|
134
|
+
"type": "string",
|
|
135
|
+
"description": "Optional parameter. If provided, the absolute url of the list will be bound to the provided run parameter label."
|
|
136
|
+
}
|
|
137
|
+
},
|
|
138
|
+
"additionalProperties": false
|
|
139
|
+
},
|
|
140
|
+
"subactions": {
|
|
141
|
+
"description": "Sub-actions to run on the list.",
|
|
142
|
+
"type": "array",
|
|
143
|
+
"items": {
|
|
144
|
+
"anyOf": [
|
|
145
|
+
{
|
|
146
|
+
"$ref": "#/definitions/SPListSubactions/setTitle"
|
|
147
|
+
},
|
|
148
|
+
{
|
|
149
|
+
"$ref": "#/definitions/SPListSubactions/setDescription"
|
|
150
|
+
},
|
|
151
|
+
{
|
|
152
|
+
"$ref": "#/definitions/SPListSubactions/addSPField"
|
|
153
|
+
},
|
|
154
|
+
{
|
|
155
|
+
"$ref": "#/definitions/SPListSubactions/deleteSPField"
|
|
156
|
+
},
|
|
157
|
+
{
|
|
158
|
+
"$ref": "#/definitions/SPListSubactions/addSPFieldXml"
|
|
159
|
+
},
|
|
160
|
+
{
|
|
161
|
+
"$ref": "#/definitions/SPListSubactions/addSPLookupFieldXml"
|
|
162
|
+
},
|
|
163
|
+
{
|
|
164
|
+
"$ref": "#/definitions/SPListSubactions/addSiteColumn"
|
|
165
|
+
},
|
|
166
|
+
{
|
|
167
|
+
"$ref": "#/definitions/SPListSubactions/addSPView"
|
|
168
|
+
},
|
|
169
|
+
{
|
|
170
|
+
"$ref": "#/definitions/SPListSubactions/removeSPView"
|
|
171
|
+
},
|
|
172
|
+
{
|
|
173
|
+
"$ref": "#/definitions/SPListSubactions/addFile"
|
|
174
|
+
},
|
|
175
|
+
{
|
|
176
|
+
"$ref": "#/definitions/SPListSubactions/addFolder"
|
|
177
|
+
},
|
|
178
|
+
{
|
|
179
|
+
"$ref": "#/definitions/SPListSubactions/setDocumentTemplates"
|
|
180
|
+
},
|
|
181
|
+
{
|
|
182
|
+
"$ref": "#/definitions/SPListSubactions/addContentType"
|
|
183
|
+
},
|
|
184
|
+
{
|
|
185
|
+
"$ref": "#/definitions/SPListSubactions/removeContentType"
|
|
186
|
+
},
|
|
187
|
+
{
|
|
188
|
+
"$ref": "#/definitions/SPListSubactions/setClientFormCustomFormatter"
|
|
189
|
+
},
|
|
190
|
+
{
|
|
191
|
+
"$ref": "#/definitions/SPListSubactions/setSPFieldCustomFormatter"
|
|
192
|
+
},
|
|
193
|
+
{
|
|
194
|
+
"$ref": "#/definitions/SPListSubactions/associateFieldCustomizer"
|
|
195
|
+
},
|
|
196
|
+
{
|
|
197
|
+
"$ref": "#/definitions/SPListSubactions/associateListViewCommandSet"
|
|
198
|
+
}
|
|
199
|
+
]
|
|
200
|
+
},
|
|
201
|
+
"additionalItems": false
|
|
202
|
+
}
|
|
203
|
+
},
|
|
204
|
+
"required": ["listName", "templateType", "verb"],
|
|
205
|
+
"additionalProperties": false
|
|
206
|
+
},
|
|
207
|
+
"deactivateSPFeature": {
|
|
208
|
+
"type": "object",
|
|
209
|
+
"properties": {
|
|
210
|
+
"verb": {
|
|
211
|
+
"type": "string",
|
|
212
|
+
"pattern": "^deactivateSPFeature$"
|
|
213
|
+
},
|
|
214
|
+
"featureId": {
|
|
215
|
+
"type": "string",
|
|
216
|
+
"description": "The Guid of the feature to deactivate."
|
|
217
|
+
},
|
|
218
|
+
"scope": {
|
|
219
|
+
"type": "string",
|
|
220
|
+
"enum": ["web", "site"],
|
|
221
|
+
"description": "Optional parameter. The scope of the feature to deactivate. Defaults to web."
|
|
222
|
+
}
|
|
223
|
+
},
|
|
224
|
+
"required": ["featureId", "verb"]
|
|
225
|
+
},
|
|
226
|
+
"SPListSubactions": {
|
|
227
|
+
"addContentType": {
|
|
228
|
+
"type": "object",
|
|
229
|
+
"properties": {
|
|
230
|
+
"verb": {
|
|
231
|
+
"type": "string",
|
|
232
|
+
"pattern": "^addContentType$"
|
|
233
|
+
},
|
|
234
|
+
"name": {
|
|
235
|
+
"type": "string",
|
|
236
|
+
"description": "The name of the ContentType to add."
|
|
237
|
+
},
|
|
238
|
+
"id": {
|
|
239
|
+
"type": "string",
|
|
240
|
+
"description": "Optional, the id of the ContentType to add."
|
|
241
|
+
}
|
|
242
|
+
},
|
|
243
|
+
"required": ["name", "verb"],
|
|
244
|
+
"additionalProperties": false
|
|
245
|
+
},
|
|
246
|
+
"removeContentType": {
|
|
247
|
+
"type": "object",
|
|
248
|
+
"properties": {
|
|
249
|
+
"verb": {
|
|
250
|
+
"type": "string",
|
|
251
|
+
"pattern": "^removeContentType$"
|
|
252
|
+
},
|
|
253
|
+
"name": {
|
|
254
|
+
"type": "string",
|
|
255
|
+
"description": "The name of the ContentType to remove."
|
|
256
|
+
}
|
|
257
|
+
},
|
|
258
|
+
"required": ["name", "verb"],
|
|
259
|
+
"additionalProperties": false
|
|
260
|
+
},
|
|
261
|
+
"setSPFieldCustomFormatter": {
|
|
262
|
+
"type": "object",
|
|
263
|
+
"properties": {
|
|
264
|
+
"verb": {
|
|
265
|
+
"type": "string",
|
|
266
|
+
"pattern": "^setSPFieldCustomFormatter$"
|
|
267
|
+
},
|
|
268
|
+
"fieldDisplayName": {
|
|
269
|
+
"type": "string",
|
|
270
|
+
"description": "The DisplayName of the SPField to operate on."
|
|
271
|
+
},
|
|
272
|
+
"formatterJSON": {
|
|
273
|
+
"type": "object",
|
|
274
|
+
"description": "A JSON object to use as the field CustomFormatter."
|
|
275
|
+
}
|
|
276
|
+
},
|
|
277
|
+
"required": ["fieldDisplayName", "verb", "formatterJSON"],
|
|
278
|
+
"additionalProperties": false
|
|
279
|
+
},
|
|
280
|
+
"setTitle": {
|
|
281
|
+
"type": "object",
|
|
282
|
+
"properties": {
|
|
283
|
+
"verb": {
|
|
284
|
+
"type": "string",
|
|
285
|
+
"pattern": "^setTitle$"
|
|
286
|
+
},
|
|
287
|
+
"title": {
|
|
288
|
+
"type": "string",
|
|
289
|
+
"description": "The new title of the list."
|
|
290
|
+
}
|
|
291
|
+
},
|
|
292
|
+
"required": ["title", "verb"],
|
|
293
|
+
"additionalProperties": false
|
|
294
|
+
},
|
|
295
|
+
"setDescription": {
|
|
296
|
+
"type": "object",
|
|
297
|
+
"properties": {
|
|
298
|
+
"verb": {
|
|
299
|
+
"type": "string",
|
|
300
|
+
"pattern": "^setDescription$"
|
|
301
|
+
},
|
|
302
|
+
"description": {
|
|
303
|
+
"type": "string",
|
|
304
|
+
"description": "The new description of the list."
|
|
305
|
+
}
|
|
306
|
+
},
|
|
307
|
+
"required": ["description", "verb"],
|
|
308
|
+
"additionalProperties": false
|
|
309
|
+
},
|
|
310
|
+
"addSiteColumn": {
|
|
311
|
+
"type": "object",
|
|
312
|
+
"properties": {
|
|
313
|
+
"verb": {
|
|
314
|
+
"type": "string",
|
|
315
|
+
"pattern": "^addSiteColumn$"
|
|
316
|
+
},
|
|
317
|
+
"internalName": {
|
|
318
|
+
"type": "string",
|
|
319
|
+
"description": "The internal name of the site column to add."
|
|
320
|
+
},
|
|
321
|
+
"addToDefaultView": {
|
|
322
|
+
"type": "boolean",
|
|
323
|
+
"description": "Optional attribute that defaults to false. If true, the newly added field will also be added to the default view."
|
|
324
|
+
}
|
|
325
|
+
},
|
|
326
|
+
"required": ["internalName", "verb"],
|
|
327
|
+
"additionalProperties": false
|
|
328
|
+
},
|
|
329
|
+
"addSPField": {
|
|
330
|
+
"type": "object",
|
|
331
|
+
"properties": {
|
|
332
|
+
"verb": {
|
|
333
|
+
"type": "string",
|
|
334
|
+
"pattern": "^addSPField$"
|
|
335
|
+
},
|
|
336
|
+
"fieldType": {
|
|
337
|
+
"type": "string",
|
|
338
|
+
"pattern": "^(Text|Note|Number|Boolean|User|DateTime)$",
|
|
339
|
+
"description": "The type of field to add."
|
|
340
|
+
},
|
|
341
|
+
"displayName": {
|
|
342
|
+
"type": "string",
|
|
343
|
+
"description": "The display name of the field."
|
|
344
|
+
},
|
|
345
|
+
"internalName": {
|
|
346
|
+
"type": "string",
|
|
347
|
+
"description": "Optional attribute. If provided, specifies the internal name of the field. If not provided, the internal name will be based on the display name"
|
|
348
|
+
},
|
|
349
|
+
"isRequired": {
|
|
350
|
+
"type": "boolean",
|
|
351
|
+
"description": "Whether this field is required to contain information."
|
|
352
|
+
},
|
|
353
|
+
"addToDefaultView": {
|
|
354
|
+
"type": "boolean",
|
|
355
|
+
"description": "Optional attribute that defaults to false. If true, the newly added field will also be added to the default view."
|
|
356
|
+
},
|
|
357
|
+
"enforceUnique": {
|
|
358
|
+
"type": "boolean",
|
|
359
|
+
"description": "Optional attribute that defaults to false. If true, then all values for this field must be unique."
|
|
360
|
+
},
|
|
361
|
+
"id": {
|
|
362
|
+
"type": "string",
|
|
363
|
+
"description": "Optional attribute. The ID Guid of the field. This needs to be uniquely generated Guid. It is strongly recommended that you include this attribute to ensure that this action is reentrant."
|
|
364
|
+
}
|
|
365
|
+
},
|
|
366
|
+
"required": ["displayName", "fieldType", "isRequired", "verb"],
|
|
367
|
+
"additionalProperties": false
|
|
368
|
+
},
|
|
369
|
+
"deleteSPField": {
|
|
370
|
+
"type": "object",
|
|
371
|
+
"properties": {
|
|
372
|
+
"verb": {
|
|
373
|
+
"type": "string",
|
|
374
|
+
"pattern": "^deleteSPField$"
|
|
375
|
+
},
|
|
376
|
+
"displayName": {
|
|
377
|
+
"type": "string",
|
|
378
|
+
"description": "The display name of the field to delete."
|
|
379
|
+
}
|
|
380
|
+
},
|
|
381
|
+
"required": ["displayName"],
|
|
382
|
+
"additionalProperties": false
|
|
383
|
+
},
|
|
384
|
+
"addSPFieldXml": {
|
|
385
|
+
"type": "object",
|
|
386
|
+
"properties": {
|
|
387
|
+
"verb": {
|
|
388
|
+
"type": "string",
|
|
389
|
+
"pattern": "^addSPFieldXml$"
|
|
390
|
+
},
|
|
391
|
+
"schemaXml": {
|
|
392
|
+
"type": "string",
|
|
393
|
+
"description": "The schemaXml specifying the field. See https://msdn.microsoft.com/en-us/library/office/aa979575.aspx"
|
|
394
|
+
},
|
|
395
|
+
"addToDefaultView": {
|
|
396
|
+
"type": "boolean",
|
|
397
|
+
"description": "Optional attribute that defaults to false. If true, the newly added field will also be added to the default view."
|
|
398
|
+
}
|
|
399
|
+
},
|
|
400
|
+
"required": ["schemaXml", "verb"],
|
|
401
|
+
"additionalProperties": false
|
|
402
|
+
},
|
|
403
|
+
"addSPLookupFieldXml": {
|
|
404
|
+
"type": "object",
|
|
405
|
+
"properties": {
|
|
406
|
+
"verb": {
|
|
407
|
+
"type": "string",
|
|
408
|
+
"pattern": "^addSPLookupFieldXml$"
|
|
409
|
+
},
|
|
410
|
+
"schemaXml": {
|
|
411
|
+
"type": "string",
|
|
412
|
+
"description": "The schemaXml specifying the field. See https://msdn.microsoft.com/en-us/library/office/aa979575.aspx"
|
|
413
|
+
},
|
|
414
|
+
"targetListName": {
|
|
415
|
+
"type": "string",
|
|
416
|
+
"description": "The name that identifies the list this lookup field is targeted against. Provide either this or targetListUrl."
|
|
417
|
+
},
|
|
418
|
+
"targetListUrl": {
|
|
419
|
+
"type": "string",
|
|
420
|
+
"description": "A web-relative url that identifies the list this lookup field is targeted against. Provide either this or targetListName."
|
|
421
|
+
},
|
|
422
|
+
"addToDefaultView": {
|
|
423
|
+
"type": "boolean",
|
|
424
|
+
"description": "Optional attribute that defaults to false. If true, the newly added field will also be added to the default view."
|
|
425
|
+
}
|
|
426
|
+
},
|
|
427
|
+
"required": ["schemaXml", "verb"],
|
|
428
|
+
"additionalProperties": false
|
|
429
|
+
},
|
|
430
|
+
"associateFieldCustomizer": {
|
|
431
|
+
"type": "object",
|
|
432
|
+
"properties": {
|
|
433
|
+
"verb": {
|
|
434
|
+
"type": "string",
|
|
435
|
+
"pattern": "^associateFieldCustomizer$"
|
|
436
|
+
},
|
|
437
|
+
"internalName": {
|
|
438
|
+
"type": "string",
|
|
439
|
+
"description": "The internalName of the field to customize."
|
|
440
|
+
},
|
|
441
|
+
"clientSideComponentId": {
|
|
442
|
+
"type": "string",
|
|
443
|
+
"description": "GUID of the extension to use to customize the field."
|
|
444
|
+
},
|
|
445
|
+
"clientSideComponentProperties": {
|
|
446
|
+
"type": "string",
|
|
447
|
+
"description": "This is an optional parameter, which can be used to provide properties for the Field Customizer instance."
|
|
448
|
+
}
|
|
449
|
+
},
|
|
450
|
+
"required": ["clientSideComponentId", "internalName", "verb"],
|
|
451
|
+
"additionalProperties": false
|
|
452
|
+
},
|
|
453
|
+
"associateListViewCommandSet": {
|
|
454
|
+
"type": "object",
|
|
455
|
+
"properties": {
|
|
456
|
+
"verb": {
|
|
457
|
+
"type": "string",
|
|
458
|
+
"pattern": "^associateListViewCommandSet$"
|
|
459
|
+
},
|
|
460
|
+
"title": {
|
|
461
|
+
"type": "string",
|
|
462
|
+
"description": "Title of the extension."
|
|
463
|
+
},
|
|
464
|
+
"location": {
|
|
465
|
+
"type": "string",
|
|
466
|
+
"pattern": "^(ClientSideExtension\\.ListViewCommandSet\\.ContextMenu|ClientSideExtension\\.ListViewCommandSet\\.CommandBar|ClientSideExtension\\.ListViewCommandSet)$",
|
|
467
|
+
"description": "Where the commands are displayed."
|
|
468
|
+
},
|
|
469
|
+
"clientSideComponentId": {
|
|
470
|
+
"type": "string",
|
|
471
|
+
"description": "GUID of the extension to use to customize the field."
|
|
472
|
+
},
|
|
473
|
+
"clientSideComponentProperties": {
|
|
474
|
+
"type": "string",
|
|
475
|
+
"description": "This is an optional parameter, which can be used to provide properties for the Field Customizer instance."
|
|
476
|
+
}
|
|
477
|
+
},
|
|
478
|
+
"required": ["clientSideComponentId", "title", "location", "verb"],
|
|
479
|
+
"additionalProperties": false
|
|
480
|
+
},
|
|
481
|
+
"addSPView": {
|
|
482
|
+
"type": "object",
|
|
483
|
+
"properties": {
|
|
484
|
+
"verb": {
|
|
485
|
+
"type": "string",
|
|
486
|
+
"pattern": "^addSPView$"
|
|
487
|
+
},
|
|
488
|
+
"name": {
|
|
489
|
+
"type": "string",
|
|
490
|
+
"description": "The name of the view."
|
|
491
|
+
},
|
|
492
|
+
"viewFields": {
|
|
493
|
+
"description": "An array of the internal names of the fields of the view.",
|
|
494
|
+
"type": "array",
|
|
495
|
+
"items": {
|
|
496
|
+
"type": "string"
|
|
497
|
+
}
|
|
498
|
+
},
|
|
499
|
+
"query": {
|
|
500
|
+
"type": "string",
|
|
501
|
+
"description": "A CAML query string that contains the where clause for the view's query. See https://msdn.microsoft.com/en-us/library/ms462365"
|
|
502
|
+
},
|
|
503
|
+
"rowLimit": {
|
|
504
|
+
"type": "integer",
|
|
505
|
+
"description": "The row limit of the view."
|
|
506
|
+
},
|
|
507
|
+
"isPaged": {
|
|
508
|
+
"type": "boolean",
|
|
509
|
+
"description": "Whether the view is paged."
|
|
510
|
+
},
|
|
511
|
+
"makeDefault": {
|
|
512
|
+
"type": "boolean",
|
|
513
|
+
"description": "If true, the view will be made the default view of the list."
|
|
514
|
+
},
|
|
515
|
+
"scope": {
|
|
516
|
+
"type": "string",
|
|
517
|
+
"pattern": "^(Default|Recursive|RecursiveAll|FilesOnly)$",
|
|
518
|
+
"description": "Optional. The scope of the view. See https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.spviewscope.aspx"
|
|
519
|
+
},
|
|
520
|
+
"formatterJSON": {
|
|
521
|
+
"type": "object",
|
|
522
|
+
"description": "A JSON object to use as the view CustomFormatter."
|
|
523
|
+
},
|
|
524
|
+
"addLink": {
|
|
525
|
+
"type": "string",
|
|
526
|
+
"description": "If present and not null or empty, a link to the view will added to the QuickLaunch, using the provided string as a name."
|
|
527
|
+
},
|
|
528
|
+
"viewType2": {
|
|
529
|
+
"type": "string",
|
|
530
|
+
"description": "Optional parameter. Specifies type data for the view."
|
|
531
|
+
},
|
|
532
|
+
"viewDataXml": {
|
|
533
|
+
"type": "string",
|
|
534
|
+
"description": "Optional parameter, The xml specifying the view data."
|
|
535
|
+
},
|
|
536
|
+
"replaceViewFields": {
|
|
537
|
+
"type": "boolean",
|
|
538
|
+
"description": "Optional parameter, defaulting to false. If true, the view fields already on the view will be replaced by the those specified by the viewFields paramter."
|
|
539
|
+
},
|
|
540
|
+
"columnWidthXml": {
|
|
541
|
+
"type": "string",
|
|
542
|
+
"description": "Optional parameter, The xml specifying the column width."
|
|
543
|
+
}
|
|
544
|
+
},
|
|
545
|
+
"required": ["name", "viewFields", "query", "rowLimit", "isPaged"],
|
|
546
|
+
"additionalProperties": false
|
|
547
|
+
},
|
|
548
|
+
"removeSPView": {
|
|
549
|
+
"type": "object",
|
|
550
|
+
"properties": {
|
|
551
|
+
"verb": {
|
|
552
|
+
"type": "string",
|
|
553
|
+
"pattern": "^removeSPView$"
|
|
554
|
+
},
|
|
555
|
+
"name": {
|
|
556
|
+
"type": "string",
|
|
557
|
+
"description": "The name of the view to remove."
|
|
558
|
+
}
|
|
559
|
+
},
|
|
560
|
+
"required": ["name"],
|
|
561
|
+
"additionalProperties": false
|
|
562
|
+
},
|
|
563
|
+
"addFile": {
|
|
564
|
+
"type": "object",
|
|
565
|
+
"properties": {
|
|
566
|
+
"verb": {
|
|
567
|
+
"type": "string",
|
|
568
|
+
"pattern": "^addFile$"
|
|
569
|
+
},
|
|
570
|
+
"destination": {
|
|
571
|
+
"type": "string",
|
|
572
|
+
"description": "The location in the library to copy the file to, including the filename, relative to the root of the library.",
|
|
573
|
+
"examples": ["Training Documents/Accounting/First Day.pdf"]
|
|
574
|
+
},
|
|
575
|
+
"source": {
|
|
576
|
+
"type": "string",
|
|
577
|
+
"description": "Optional parameter. The location in the site script package to copy the file from, relative to the root directory. Provide either this or sourceUrl."
|
|
578
|
+
},
|
|
579
|
+
"sourceUrl": {
|
|
580
|
+
"type": "string",
|
|
581
|
+
"description": "Optional parameter. The location in the tenant to copy the file from, as an absolute url. Provide either this or source."
|
|
582
|
+
}
|
|
583
|
+
},
|
|
584
|
+
"required": ["verb", "destination"],
|
|
585
|
+
"additionalProperties": false
|
|
586
|
+
},
|
|
587
|
+
"addFolder": {
|
|
588
|
+
"type": "object",
|
|
589
|
+
"properties": {
|
|
590
|
+
"verb": {
|
|
591
|
+
"type": "string",
|
|
592
|
+
"pattern": "^addFolder$"
|
|
593
|
+
},
|
|
594
|
+
"path": {
|
|
595
|
+
"type": "string",
|
|
596
|
+
"description": "The path of the new folder, relative to the root of the library.",
|
|
597
|
+
"examples": ["Training Documents/Accounting"]
|
|
598
|
+
}
|
|
599
|
+
},
|
|
600
|
+
"required": ["verb", "path"],
|
|
601
|
+
"additionalProperties": false
|
|
602
|
+
},
|
|
603
|
+
"setDocumentTemplates": {
|
|
604
|
+
"type": "object",
|
|
605
|
+
"properties": {
|
|
606
|
+
"verb": {
|
|
607
|
+
"type": "string",
|
|
608
|
+
"pattern": "^setDocumentTemplates$"
|
|
609
|
+
},
|
|
610
|
+
"templateJSON": {
|
|
611
|
+
"type": "object",
|
|
612
|
+
"description": "A JSON object representing the new document templates."
|
|
613
|
+
}
|
|
614
|
+
},
|
|
615
|
+
"required": ["verb", "templateJSON"],
|
|
616
|
+
"additionalProperties": false
|
|
617
|
+
},
|
|
618
|
+
"setClientFormCustomFormatter": {
|
|
619
|
+
"type": "object",
|
|
620
|
+
"properties": {
|
|
621
|
+
"verb": {
|
|
622
|
+
"type": "string",
|
|
623
|
+
"pattern": "^setClientFormCustomFormatter$"
|
|
624
|
+
},
|
|
625
|
+
"clientFormCustomFormatter": {
|
|
626
|
+
"type": "object",
|
|
627
|
+
"description": "A JSON object representing the formatter for form."
|
|
628
|
+
}
|
|
629
|
+
},
|
|
630
|
+
"required": ["clientFormCustomFormatter", "verb"],
|
|
631
|
+
"additionalProperties": false
|
|
632
|
+
}
|
|
633
|
+
},
|
|
634
|
+
"addPrincipalToSPGroup": {
|
|
635
|
+
"type": "object",
|
|
636
|
+
"properties": {
|
|
637
|
+
"verb": {
|
|
638
|
+
"type": "string",
|
|
639
|
+
"pattern": "^addPrincipalToSPGroup$"
|
|
640
|
+
},
|
|
641
|
+
"principal": {
|
|
642
|
+
"type": "string",
|
|
643
|
+
"description": "The name of principal to add to the SPGroup."
|
|
644
|
+
},
|
|
645
|
+
"group": {
|
|
646
|
+
"type": "string",
|
|
647
|
+
"description": "The SPGroup to add the principal to.",
|
|
648
|
+
"pattern": "^(Members|Owners|Visitors)$"
|
|
649
|
+
}
|
|
650
|
+
},
|
|
651
|
+
"required": ["principal", "group", "verb"]
|
|
652
|
+
},
|
|
653
|
+
"applyTheme": {
|
|
654
|
+
"type": "object",
|
|
655
|
+
"properties": {
|
|
656
|
+
"verb": {
|
|
657
|
+
"type": "string",
|
|
658
|
+
"pattern": "^applyTheme$"
|
|
659
|
+
},
|
|
660
|
+
"themeName": {
|
|
661
|
+
"type": "string",
|
|
662
|
+
"description": "The name of the theme to apply. Provide either this or themeJson."
|
|
663
|
+
},
|
|
664
|
+
"themeJson": {
|
|
665
|
+
"type": "object",
|
|
666
|
+
"description": "An optional JSON object specifying the theme exactly. Provide either this or themeName. See https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-theming/sharepoint-site-theming-json-schema for information on how to generate this object."
|
|
667
|
+
}
|
|
668
|
+
},
|
|
669
|
+
"required": ["verb"]
|
|
670
|
+
},
|
|
671
|
+
"setSiteLogo": {
|
|
672
|
+
"type": "object",
|
|
673
|
+
"properties": {
|
|
674
|
+
"verb": {
|
|
675
|
+
"type": "string",
|
|
676
|
+
"pattern": "^setSiteLogo$"
|
|
677
|
+
},
|
|
678
|
+
"url": {
|
|
679
|
+
"type": "string",
|
|
680
|
+
"description": "The URL of the new SiteLogo."
|
|
681
|
+
}
|
|
682
|
+
},
|
|
683
|
+
"required": ["url", "verb"]
|
|
684
|
+
},
|
|
685
|
+
"setSiteLogoFromFile": {
|
|
686
|
+
"type": "object",
|
|
687
|
+
"properties": {
|
|
688
|
+
"verb": {
|
|
689
|
+
"type": "string",
|
|
690
|
+
"pattern": "^setSiteLogoFromFile$"
|
|
691
|
+
},
|
|
692
|
+
"source": {
|
|
693
|
+
"type": "string",
|
|
694
|
+
"description": "The location in the site script package to copy the image file from, relative to the root directory. Provide either this or sourceUrl or templateImageUrl."
|
|
695
|
+
},
|
|
696
|
+
"sourceUrl": {
|
|
697
|
+
"type": "string",
|
|
698
|
+
"description": "Optional parameter. The location in the tenant to copy the image file from, as an absolute url. Provide either this or source or templateImageUrl."
|
|
699
|
+
},
|
|
700
|
+
"templateImageUrl": {
|
|
701
|
+
"type": "string",
|
|
702
|
+
"description": "Optional parameter. The location of the template image file. Provide either this or source or sourceUrl."
|
|
703
|
+
}
|
|
704
|
+
},
|
|
705
|
+
"required": ["verb"]
|
|
706
|
+
},
|
|
707
|
+
"triggerFlow": {
|
|
708
|
+
"type": "object",
|
|
709
|
+
"properties": {
|
|
710
|
+
"verb": {
|
|
711
|
+
"type": "string",
|
|
712
|
+
"pattern": "^triggerFlow$"
|
|
713
|
+
},
|
|
714
|
+
"url": {
|
|
715
|
+
"type": "string",
|
|
716
|
+
"description": "The trigger URL of the Flow."
|
|
717
|
+
},
|
|
718
|
+
"name": {
|
|
719
|
+
"type": "string",
|
|
720
|
+
"description": "The name of the Flow."
|
|
721
|
+
},
|
|
722
|
+
"waitForReply": {
|
|
723
|
+
"type": "boolean",
|
|
724
|
+
"description": "If true, the script will expect that the Flow will call Microsoft.SharePoint.Utilities.WebTemplateExtensions.SiteScriptUtility.SetSiteScriptStageOutcome() when it has finished executing. Note that this will not cause the script to block. The script will keep executing, but for record-keeping purposes, the run will be considered incomplete until the reply is made."
|
|
725
|
+
},
|
|
726
|
+
"parameters": {
|
|
727
|
+
"type": "object",
|
|
728
|
+
"description": "An option set of parameters to pass into the Flow."
|
|
729
|
+
}
|
|
730
|
+
},
|
|
731
|
+
"required": ["name", "url", "verb"],
|
|
732
|
+
"additionalProperties": false
|
|
733
|
+
},
|
|
734
|
+
"installSolution": {
|
|
735
|
+
"type": "object",
|
|
736
|
+
"properties": {
|
|
737
|
+
"verb": {
|
|
738
|
+
"type": "string",
|
|
739
|
+
"pattern": "^installSolution$"
|
|
740
|
+
},
|
|
741
|
+
"id": {
|
|
742
|
+
"type": "string",
|
|
743
|
+
"description": "The ID of the Solution."
|
|
744
|
+
},
|
|
745
|
+
"name": {
|
|
746
|
+
"type": "string",
|
|
747
|
+
"description": "The name of the Solution."
|
|
748
|
+
}
|
|
749
|
+
},
|
|
750
|
+
"required": ["id", "verb", "name"],
|
|
751
|
+
"additionalProperties": false
|
|
752
|
+
},
|
|
753
|
+
"addNavLink": {
|
|
754
|
+
"type": "object",
|
|
755
|
+
"properties": {
|
|
756
|
+
"verb": {
|
|
757
|
+
"type": "string",
|
|
758
|
+
"pattern": "^addNavLink$"
|
|
759
|
+
},
|
|
760
|
+
"url": {
|
|
761
|
+
"type": "string",
|
|
762
|
+
"description": "The url of the link to add."
|
|
763
|
+
},
|
|
764
|
+
"displayName": {
|
|
765
|
+
"type": "string",
|
|
766
|
+
"description": "The display name of the link"
|
|
767
|
+
},
|
|
768
|
+
"isWebRelative": {
|
|
769
|
+
"type": "boolean",
|
|
770
|
+
"description": "Optionally indicates whether the link is web-relative. The default is false."
|
|
771
|
+
},
|
|
772
|
+
"parentDisplayName": {
|
|
773
|
+
"type": "string",
|
|
774
|
+
"description": "Optional parameter. If provided, makes this nav link a child of the nav link with this displayName. If both this and parentUrl are provided, it searches for a link that matches both to be the parent."
|
|
775
|
+
},
|
|
776
|
+
"parentUrl": {
|
|
777
|
+
"type": "string",
|
|
778
|
+
"description": "Optional parameter. If provided, makes this nav link a child of the nav link with this url. If both this and parentDisplayName are provided, it searches for a link that matches both to be the parent."
|
|
779
|
+
},
|
|
780
|
+
"isParentUrlWebRelative": {
|
|
781
|
+
"type": "boolean",
|
|
782
|
+
"description": "Optional parameter. Indicates whether parentUrl is web-relative. The default is false."
|
|
783
|
+
},
|
|
784
|
+
"navComponent": {
|
|
785
|
+
"type": "string",
|
|
786
|
+
"description": "Which nav component to add the link to. The QuickLaunch is the default",
|
|
787
|
+
"pattern": "^(QuickLaunch|Hub|Footer)$"
|
|
788
|
+
}
|
|
789
|
+
},
|
|
790
|
+
"required": ["displayName", "url", "verb"],
|
|
791
|
+
"additionalProperties": false
|
|
792
|
+
},
|
|
793
|
+
"removeNavLink": {
|
|
794
|
+
"type": "object",
|
|
795
|
+
"properties": {
|
|
796
|
+
"verb": {
|
|
797
|
+
"type": "string",
|
|
798
|
+
"pattern": "^removeNavLink$"
|
|
799
|
+
},
|
|
800
|
+
"url": {
|
|
801
|
+
"type": "string",
|
|
802
|
+
"description": "Optionally indicates the url of the link to remove. if this parameter is not provided, the link to be removed will be found based on the displayName only."
|
|
803
|
+
},
|
|
804
|
+
"displayName": {
|
|
805
|
+
"type": "string",
|
|
806
|
+
"description": "The display name of the link to remove."
|
|
807
|
+
},
|
|
808
|
+
"isWebRelative": {
|
|
809
|
+
"type": "boolean",
|
|
810
|
+
"description": "Optionally indicates whether the link is web-relative. The default is false."
|
|
811
|
+
},
|
|
812
|
+
"navComponent": {
|
|
813
|
+
"type": "string",
|
|
814
|
+
"description": "Which nav component to remove the link from. The QuickLaunch is the default",
|
|
815
|
+
"pattern": "^(QuickLaunch|Hub|Footer)$"
|
|
816
|
+
}
|
|
817
|
+
},
|
|
818
|
+
"required": ["displayName", "verb"],
|
|
819
|
+
"additionalProperties": false
|
|
820
|
+
},
|
|
821
|
+
"joinHubSite": {
|
|
822
|
+
"type": "object",
|
|
823
|
+
"properties": {
|
|
824
|
+
"verb": {
|
|
825
|
+
"type": "string",
|
|
826
|
+
"pattern": "^joinHubSite$"
|
|
827
|
+
},
|
|
828
|
+
"hubSiteId": {
|
|
829
|
+
"type": "string",
|
|
830
|
+
"description": "A Guid specifying the hub site."
|
|
831
|
+
},
|
|
832
|
+
"name": {
|
|
833
|
+
"type": "string",
|
|
834
|
+
"description": "An optional string specifying the name of the hub site."
|
|
835
|
+
}
|
|
836
|
+
},
|
|
837
|
+
"required": ["hubSiteId", "verb"],
|
|
838
|
+
"additionalProperties": false
|
|
839
|
+
},
|
|
840
|
+
"createContentType": {
|
|
841
|
+
"type": "object",
|
|
842
|
+
"properties": {
|
|
843
|
+
"verb": {
|
|
844
|
+
"type": "string",
|
|
845
|
+
"pattern": "^createContentType$"
|
|
846
|
+
},
|
|
847
|
+
"name": {
|
|
848
|
+
"type": "string",
|
|
849
|
+
"description": "Name of the content type."
|
|
850
|
+
},
|
|
851
|
+
"description": {
|
|
852
|
+
"type": "string",
|
|
853
|
+
"description": "Optional description of the content type."
|
|
854
|
+
},
|
|
855
|
+
"parentName": {
|
|
856
|
+
"type": "string",
|
|
857
|
+
"description": "Name of the parent content type. Provide either this, parentId, or id."
|
|
858
|
+
},
|
|
859
|
+
"parentId": {
|
|
860
|
+
"type": "string",
|
|
861
|
+
"description": "Id of the parent content type. Provide either this, parentName, or id."
|
|
862
|
+
},
|
|
863
|
+
"id": {
|
|
864
|
+
"type": "string",
|
|
865
|
+
"description": "Id of the content type. Provide either this, parentName, or parentId."
|
|
866
|
+
},
|
|
867
|
+
"hidden": {
|
|
868
|
+
"type": "boolean",
|
|
869
|
+
"description": "Whether the content type is hidden."
|
|
870
|
+
},
|
|
871
|
+
"group": {
|
|
872
|
+
"type": "string",
|
|
873
|
+
"description": "Optional parameter. If provided, sets the group of the content type."
|
|
874
|
+
},
|
|
875
|
+
"subactions": {
|
|
876
|
+
"description": "Sub-actions to run on the content type.",
|
|
877
|
+
"type": "array",
|
|
878
|
+
"items": {
|
|
879
|
+
"anyOf": [
|
|
880
|
+
{
|
|
881
|
+
"$ref": "#/definitions/SPContentTypeSubactions/addSiteColumn"
|
|
882
|
+
},
|
|
883
|
+
{
|
|
884
|
+
"$ref": "#/definitions/SPContentTypeSubactions/removeSiteColumn"
|
|
885
|
+
}
|
|
886
|
+
]
|
|
887
|
+
},
|
|
888
|
+
"additionalItems": false
|
|
889
|
+
}
|
|
890
|
+
},
|
|
891
|
+
"required": ["verb", "name", "hidden"],
|
|
892
|
+
"additionalProperties": false
|
|
893
|
+
},
|
|
894
|
+
"SPContentTypeSubactions": {
|
|
895
|
+
"addSiteColumn": {
|
|
896
|
+
"type": "object",
|
|
897
|
+
"properties": {
|
|
898
|
+
"verb": {
|
|
899
|
+
"type": "string",
|
|
900
|
+
"pattern": "^addSiteColumn$"
|
|
901
|
+
},
|
|
902
|
+
"internalName": {
|
|
903
|
+
"type": "string",
|
|
904
|
+
"description": "The internal name of the site column to add."
|
|
905
|
+
}
|
|
906
|
+
},
|
|
907
|
+
"required": ["internalName", "verb"],
|
|
908
|
+
"additionalProperties": false
|
|
909
|
+
},
|
|
910
|
+
"removeSiteColumn": {
|
|
911
|
+
"type": "object",
|
|
912
|
+
"properties": {
|
|
913
|
+
"verb": {
|
|
914
|
+
"type": "string",
|
|
915
|
+
"pattern": "^removeSiteColumn$"
|
|
916
|
+
},
|
|
917
|
+
"internalName": {
|
|
918
|
+
"type": "string",
|
|
919
|
+
"description": "The internal name of the site column to remove."
|
|
920
|
+
}
|
|
921
|
+
},
|
|
922
|
+
"required": ["internalName", "verb"],
|
|
923
|
+
"additionalProperties": false
|
|
924
|
+
}
|
|
925
|
+
},
|
|
926
|
+
"createSiteColumn": {
|
|
927
|
+
"type": "object",
|
|
928
|
+
"properties": {
|
|
929
|
+
"verb": {
|
|
930
|
+
"type": "string",
|
|
931
|
+
"pattern": "^createSiteColumn$"
|
|
932
|
+
},
|
|
933
|
+
"fieldType": {
|
|
934
|
+
"type": "string",
|
|
935
|
+
"pattern": "^(Text|Note|Number|Boolean|User|DateTime)$",
|
|
936
|
+
"description": "The type of column to add."
|
|
937
|
+
},
|
|
938
|
+
"internalName": {
|
|
939
|
+
"type": "string",
|
|
940
|
+
"description": "Internal name of the column"
|
|
941
|
+
},
|
|
942
|
+
"displayName": {
|
|
943
|
+
"type": "string",
|
|
944
|
+
"description": "Optional display name of the column."
|
|
945
|
+
},
|
|
946
|
+
"isRequired": {
|
|
947
|
+
"type": "boolean",
|
|
948
|
+
"description": "Whether this column is required to contain information."
|
|
949
|
+
},
|
|
950
|
+
"group": {
|
|
951
|
+
"type": "string",
|
|
952
|
+
"description": "Optional attribute. If provided, sets the column group to which this column belongs."
|
|
953
|
+
},
|
|
954
|
+
"enforceUnique": {
|
|
955
|
+
"type": "boolean",
|
|
956
|
+
"description": "Optional attribute that defaults to false. If true, then all values for this column must be unique."
|
|
957
|
+
},
|
|
958
|
+
"id": {
|
|
959
|
+
"type": "string",
|
|
960
|
+
"description": "Optional attribute. The ID Guid of the field. This needs to be uniquely generated Guid. It is strongly recommended that you include this attribute to ensure that this action is reentrant."
|
|
961
|
+
}
|
|
962
|
+
},
|
|
963
|
+
"required": ["fieldType", "verb", "internalName", "isRequired"],
|
|
964
|
+
"additionalProperties": false
|
|
965
|
+
},
|
|
966
|
+
"createSiteColumnXml": {
|
|
967
|
+
"type": "object",
|
|
968
|
+
"properties": {
|
|
969
|
+
"verb": {
|
|
970
|
+
"type": "string",
|
|
971
|
+
"pattern": "^createSiteColumnXml$"
|
|
972
|
+
},
|
|
973
|
+
"schemaXml": {
|
|
974
|
+
"type": "string",
|
|
975
|
+
"description": "The schemaXml specifying the field. See https://msdn.microsoft.com/en-us/library/office/aa979575.aspx"
|
|
976
|
+
},
|
|
977
|
+
"pushChanges": {
|
|
978
|
+
"type": "boolean",
|
|
979
|
+
"description": "Indicates whether this change should be pushed to lists that already reference this field. Defaults to true."
|
|
980
|
+
}
|
|
981
|
+
},
|
|
982
|
+
"required": ["verb", "schemaXml"],
|
|
983
|
+
"additionalProperties": false
|
|
984
|
+
},
|
|
985
|
+
"setSiteExternalSharingCapability": {
|
|
986
|
+
"type": "object",
|
|
987
|
+
"properties": {
|
|
988
|
+
"verb": {
|
|
989
|
+
"type": "string",
|
|
990
|
+
"pattern": "^setSiteExternalSharingCapability$"
|
|
991
|
+
},
|
|
992
|
+
"capability": {
|
|
993
|
+
"type": "string",
|
|
994
|
+
"pattern": "^(Disabled|ExistingExternalUserSharingOnly|ExternalUserSharingOnly|ExternalUserAndGuestSharing)$",
|
|
995
|
+
"description": "A string specifying the sharing capability for the site."
|
|
996
|
+
}
|
|
997
|
+
},
|
|
998
|
+
"required": ["capability", "verb"],
|
|
999
|
+
"additionalProperties": false
|
|
1000
|
+
},
|
|
1001
|
+
"setRegionalSettings": {
|
|
1002
|
+
"type": "object",
|
|
1003
|
+
"properties": {
|
|
1004
|
+
"verb": {
|
|
1005
|
+
"type": "string",
|
|
1006
|
+
"pattern": "^setRegionalSettings$"
|
|
1007
|
+
},
|
|
1008
|
+
"timeZone": {
|
|
1009
|
+
"type": "integer",
|
|
1010
|
+
"description": "A number specifying the time zone. See https://msdn.microsoft.com/library/microsoft.sharepoint.spregionalsettings.timezones.aspx"
|
|
1011
|
+
},
|
|
1012
|
+
"locale": {
|
|
1013
|
+
"type": "integer",
|
|
1014
|
+
"description": "A number specifying the culture by lcid. See https://msdn.microsoft.com/en-us/library/ms912047(v=winembedded.10).aspx"
|
|
1015
|
+
},
|
|
1016
|
+
"sortOrder": {
|
|
1017
|
+
"type": "integer",
|
|
1018
|
+
"description": "A number specifying the sort order. See https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.spregionalsettings.collation.aspx"
|
|
1019
|
+
},
|
|
1020
|
+
"hourFormat": {
|
|
1021
|
+
"type": "string",
|
|
1022
|
+
"pattern": "^(12|24)$",
|
|
1023
|
+
"description": "Specifies whether the site should use 12-hour or 24-hour time."
|
|
1024
|
+
}
|
|
1025
|
+
},
|
|
1026
|
+
"required": ["sortOrder", "verb"],
|
|
1027
|
+
"additionalProperties": false
|
|
1028
|
+
},
|
|
1029
|
+
"setSiteBranding": {
|
|
1030
|
+
"type": "object",
|
|
1031
|
+
"properties": {
|
|
1032
|
+
"verb": {
|
|
1033
|
+
"type": "string",
|
|
1034
|
+
"pattern": "^setSiteBranding$"
|
|
1035
|
+
},
|
|
1036
|
+
"navigationLayout": {
|
|
1037
|
+
"type": "string",
|
|
1038
|
+
"pattern": "^(Cascade|Megamenu)$",
|
|
1039
|
+
"description": "Specifies the layout of the navigation. If this parameter is omitted, the layout will not be changed."
|
|
1040
|
+
},
|
|
1041
|
+
"headerLayout": {
|
|
1042
|
+
"type": "string",
|
|
1043
|
+
"pattern": "^(Standard|Compact)$",
|
|
1044
|
+
"description": "Specifies the layout of the header. If this parameter is omitted, the layout will not be changed."
|
|
1045
|
+
},
|
|
1046
|
+
"headerBackground": {
|
|
1047
|
+
"type": "string",
|
|
1048
|
+
"pattern": "^(None|Neutral|Soft|Strong)$",
|
|
1049
|
+
"description": "Specifies the emphasis on the background color of the header. If this parameter is omitted, it will not be changed."
|
|
1050
|
+
},
|
|
1051
|
+
"showFooter": {
|
|
1052
|
+
"type": "boolean",
|
|
1053
|
+
"description": "Specifies whether the footer should be visible. If this parameter is omitted. The visibility of the footer will not be changed."
|
|
1054
|
+
}
|
|
1055
|
+
},
|
|
1056
|
+
"required": ["verb"],
|
|
1057
|
+
"additionalProperties": false
|
|
1058
|
+
},
|
|
1059
|
+
"setFooterLogo": {
|
|
1060
|
+
"type": "object",
|
|
1061
|
+
"properties": {
|
|
1062
|
+
"verb": {
|
|
1063
|
+
"type": "string",
|
|
1064
|
+
"pattern": "^setFooterLogo$"
|
|
1065
|
+
},
|
|
1066
|
+
"imageUrl": {
|
|
1067
|
+
"type": "string",
|
|
1068
|
+
"description": "The image URL of the footer logo. If empty string is provided, the current footer logo will be removed."
|
|
1069
|
+
},
|
|
1070
|
+
"imageUrlType": {
|
|
1071
|
+
"type": "string",
|
|
1072
|
+
"enum": ["WebRelativeUrl", "TemplateImage"],
|
|
1073
|
+
"description": "Optional parameter. Specifies the type of imageUrl. The default is WebRelativeUrl."
|
|
1074
|
+
}
|
|
1075
|
+
},
|
|
1076
|
+
"required": ["verb", "imageUrl"]
|
|
1077
|
+
}
|
|
1078
|
+
},
|
|
1079
|
+
"type": "object",
|
|
1080
|
+
"properties": {
|
|
1081
|
+
"actions": {
|
|
1082
|
+
"title": "array of supported actions",
|
|
1083
|
+
"type": "array",
|
|
1084
|
+
"items": {
|
|
1085
|
+
"anyOf": [
|
|
1086
|
+
{
|
|
1087
|
+
"$ref": "#/definitions/activateSPFeature"
|
|
1088
|
+
},
|
|
1089
|
+
{
|
|
1090
|
+
"$ref": "#/definitions/addContentTypesFromHub"
|
|
1091
|
+
},
|
|
1092
|
+
{
|
|
1093
|
+
"$ref": "#/definitions/associateExtension"
|
|
1094
|
+
},
|
|
1095
|
+
{
|
|
1096
|
+
"$ref": "#/definitions/addPrincipalToSPGroup"
|
|
1097
|
+
},
|
|
1098
|
+
{
|
|
1099
|
+
"$ref": "#/definitions/addNavLink"
|
|
1100
|
+
},
|
|
1101
|
+
{
|
|
1102
|
+
"$ref": "#/definitions/applyTheme"
|
|
1103
|
+
},
|
|
1104
|
+
{
|
|
1105
|
+
"$ref": "#/definitions/createContentType"
|
|
1106
|
+
},
|
|
1107
|
+
{
|
|
1108
|
+
"$ref": "#/definitions/createSiteColumn"
|
|
1109
|
+
},
|
|
1110
|
+
{
|
|
1111
|
+
"$ref": "#/definitions/createSiteColumnXml"
|
|
1112
|
+
},
|
|
1113
|
+
{
|
|
1114
|
+
"$ref": "#/definitions/createSPList"
|
|
1115
|
+
},
|
|
1116
|
+
{
|
|
1117
|
+
"$ref": "#/definitions/deactivateSPFeature"
|
|
1118
|
+
},
|
|
1119
|
+
{
|
|
1120
|
+
"$ref": "#/definitions/installSolution"
|
|
1121
|
+
},
|
|
1122
|
+
{
|
|
1123
|
+
"$ref": "#/definitions/joinHubSite"
|
|
1124
|
+
},
|
|
1125
|
+
{
|
|
1126
|
+
"$ref": "#/definitions/removeNavLink"
|
|
1127
|
+
},
|
|
1128
|
+
{
|
|
1129
|
+
"$ref": "#/definitions/setRegionalSettings"
|
|
1130
|
+
},
|
|
1131
|
+
{
|
|
1132
|
+
"$ref": "#/definitions/setSiteBranding"
|
|
1133
|
+
},
|
|
1134
|
+
{
|
|
1135
|
+
"$ref": "#/definitions/setSiteLogo"
|
|
1136
|
+
},
|
|
1137
|
+
{
|
|
1138
|
+
"$ref": "#/definitions/setSiteLogoFromFile"
|
|
1139
|
+
},
|
|
1140
|
+
{
|
|
1141
|
+
"$ref": "#/definitions/setSiteExternalSharingCapability"
|
|
1142
|
+
},
|
|
1143
|
+
{
|
|
1144
|
+
"$ref": "#/definitions/triggerFlow"
|
|
1145
|
+
},
|
|
1146
|
+
{
|
|
1147
|
+
"$ref": "#/definitions/setFooterLogo"
|
|
1148
|
+
}
|
|
1149
|
+
]
|
|
1150
|
+
},
|
|
1151
|
+
"additionalItems": false
|
|
1152
|
+
},
|
|
1153
|
+
"$schema": {
|
|
1154
|
+
"type": "string"
|
|
1155
|
+
}
|
|
1156
|
+
},
|
|
1157
|
+
"additionalProperties": false
|
|
1158
|
+
}
|