@jahia/cypress 8.2.0 → 8.3.0

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/schema.graphql DELETED
@@ -1,4569 +0,0 @@
1
- # This file was generated. Do not edit manually.
2
-
3
- schema {
4
- query: Query
5
- mutation: Mutation
6
- subscription: Subscription
7
- }
8
-
9
- directive @fetcher(name: String) on FIELD_DEFINITION
10
-
11
- directive @mapping(ignoreDefaultQueries: Boolean, node: String, property: String) on OBJECT | FIELD_DEFINITION
12
-
13
- "Indicates an Input Object is a OneOf Input Object."
14
- directive @oneOf on INPUT_OBJECT
15
-
16
- "GraphQL representation of a JCR item definition"
17
- interface JCRItemDefinition {
18
- "Reports whether the item is to be automatically created when its parent node is created."
19
- autoCreated: Boolean!
20
- "Gets the node type that contains the declaration of this definition."
21
- declaringNodeType: JCRNodeType!
22
- "Reports whether the child item is hidden from UI."
23
- hidden: Boolean!
24
- "Reports whether the item is mandatory. A mandatory item is one that, if its parent node exists, must also exist."
25
- mandatory: Boolean!
26
- "Gets the name of the child item."
27
- name: String!
28
- "Reports whether the child item is protected."
29
- protected: Boolean!
30
- }
31
-
32
- "GraphQL representation of a JCR node"
33
- interface JCRNode {
34
- "Get ACL info for this node"
35
- acl: GqlAcl
36
- "Get the last modified date of this node and its descendants. The recursion in descendants can be controlled by recursionTypesFilter. If no filter is passed, recursion will stop by default on sub pages."
37
- aggregatedLastModifiedDate(
38
- "The language to use to get the last modified date, if not specified, returns last modification date in any language"
39
- language: String,
40
- "Stop recursion on nodes by their types; null to avoid such filtering"
41
- recursionTypesFilter: InputNodeTypesInput
42
- ): String
43
- "Aggregated publication info about the JCR node"
44
- aggregatedPublicationInfo(
45
- "Publication language"
46
- language: String!,
47
- "Whether to take references into account when calculating the aggregated publication status"
48
- references: Boolean = false,
49
- "Whether to take sub-nodes into account when calculating the aggregated publication status"
50
- subNodes: Boolean = false
51
- ): GqlPublicationInfo!
52
- "Render URL in ajax mode"
53
- ajaxRenderUrl: String
54
- "Returns a list of types allowed under the provided node"
55
- allowedChildNodeTypes(
56
- "Filter by GraphQL fields values"
57
- fieldFilter: InputFieldFiltersInput,
58
- "Whether all sub-types of allowed child node types should be included"
59
- includeSubTypes: Boolean = true
60
- ): [JCRNodeType]
61
- "GraphQL representations of the ancestor nodes of the JCR node, top down direction"
62
- ancestors(
63
- "Filter by graphQL fields values"
64
- fieldFilter: InputFieldFiltersInput,
65
- "The path of the topmost ancestor node to include in the result; null or empty string to include all the ancestor nodes"
66
- upToPath: String
67
- ): [JCRNode]!
68
- "GraphQL representations of the child nodes, according to parameters passed"
69
- children(
70
- "fetching only nodes after this node (exclusive)"
71
- after: String,
72
- "fetching only nodes before this node (exclusive)"
73
- before: String,
74
- "Filter by graphQL fields values"
75
- fieldFilter: InputFieldFiltersInput,
76
- "Group fields according to specified criteria"
77
- fieldGrouping: InputFieldGroupingInput,
78
- "Sort by graphQL fields values"
79
- fieldSorter: InputFieldSorterInput,
80
- "fetching only the first certain number of nodes"
81
- first: Int,
82
- "Include the current node itself in results"
83
- includesSelf: Boolean = false,
84
- "fetching only the last certain number of nodes"
85
- last: Int,
86
- "fetching only the first certain number of nodes"
87
- limit: Int,
88
- "Filter of child nodes by their names; null to avoid such filtering"
89
- names: [String],
90
- "fetching only nodes after this node (inclusive)"
91
- offset: Int,
92
- "Filter of child nodes by their property values; null to avoid such filtering"
93
- propertiesFilter: InputNodePropertiesInput,
94
- "Filter of child nodes by their types; null to avoid such filtering"
95
- typesFilter: InputNodeTypesInput,
96
- "Language to use to get children"
97
- validInLanguage: String
98
- ): JCRNodeConnection
99
- "Read default Work in progress information. Set by \"wip.checkbox.checked\" system proprety"
100
- defaultWipInfo: wipInfo
101
- "Returns the node definition that applies to this node."
102
- definition: JCRNodeDefinition
103
- "The depth in the JCR Tree of the JCR node this object represents"
104
- depth: Int!
105
- "GraphQL representation of a descendant node, based on its relative path"
106
- descendant(
107
- "Name or relative path of the sub node"
108
- relPath: String!
109
- ): JCRNode
110
- "GraphQL representations of the descendant nodes, according to parameters passed"
111
- descendants(
112
- "fetching only nodes after this node (exclusive)"
113
- after: String,
114
- "fetching only nodes before this node (exclusive)"
115
- before: String,
116
- "Filter by graphQL fields values"
117
- fieldFilter: InputFieldFiltersInput,
118
- "Group fields according to specified criteria"
119
- fieldGrouping: InputFieldGroupingInput,
120
- "Sort by graphQL fields values"
121
- fieldSorter: InputFieldSorterInput,
122
- "fetching only the first certain number of nodes"
123
- first: Int,
124
- "fetching only the last certain number of nodes"
125
- last: Int,
126
- "fetching only the first certain number of nodes"
127
- limit: Int,
128
- "Maximum depth in JCR tree for descendants from the current node, 0 (or less) for all sub nodes, 1 for one sub level, etc"
129
- maxDepth: Int,
130
- "fetching only nodes after this node (inclusive)"
131
- offset: Int,
132
- "Filter of descendant nodes by their property values; null to avoid such filtering"
133
- propertiesFilter: InputNodePropertiesInput,
134
- "Filter out and stop recursion on nodes by their property values; null to avoid such filtering"
135
- recursionPropertiesFilter: InputNodePropertiesInput,
136
- "Filter out and stop recursion on nodes by their types; null to avoid such filtering"
137
- recursionTypesFilter: InputNodeTypesInput,
138
- "Filter of descendant nodes by their types; null to avoid such filtering"
139
- typesFilter: InputNodeTypesInput,
140
- "Language to use to get children"
141
- validInLanguage: String
142
- ): JCRNodeConnection
143
- "The display name of the JCR node this object represents in the requested language"
144
- displayName(
145
- "The language to obtain the display name in"
146
- language: String
147
- ): String
148
- "Returns the first parent of the current node that can be displayed in full page. If no matching node is found, null is returned."
149
- displayableNode: JCRNode
150
- "Returns the next available name for a node, appending if needed numbers."
151
- findAvailableNodeName(language: String, nodeType: String): String
152
- "Check if the current user has a specific permission"
153
- hasPermission(
154
- "The name of the permission"
155
- permissionName: String!
156
- ): Boolean
157
- "Check if the node as a renderable template associated with it (not a view a template)."
158
- isDisplayableNode: Boolean
159
- "true if node is under a mounted node"
160
- isExternal: Boolean!
161
- "Reports if the current node matches the nodetype(s) passed in parameter"
162
- isNodeType(
163
- "Node type name"
164
- type: InputNodeTypesInput!
165
- ): Boolean!
166
- "Check if the given locales need translation, by comparing last modifications dates with already existing translations"
167
- languagesToTranslate(
168
- "List of languages potentially to be translated"
169
- languagesToCheck: [String],
170
- "List of known translated languages, will be used to compare modifications dates"
171
- languagesTranslated: [String]
172
- ): [String]
173
- "Retrieve lock info of the current node"
174
- lockInfo: LockInfo
175
- "Returns edit lock status of the current node object"
176
- lockedAndCannotBeEdited: Boolean
177
- "Returns an array of <code>NodeType</code> objects representing the mixin node types in effect for this node."
178
- mixinTypes(
179
- "Filter by GraphQL fields values"
180
- fieldFilter: InputFieldFiltersInput
181
- ): [JCRNodeType]!
182
- "The name of the JCR node this object represents"
183
- name: String!
184
- "GraphQL representation of this node in certain workspace"
185
- nodeInWorkspace(
186
- "The target workspace"
187
- workspace: Workspace!
188
- ): JCRNode
189
- "Get information on the operations that can be done on this node"
190
- operationsSupport: GqlOperationsSupport
191
- "GraphQL representation of the parent JCR node"
192
- parent: JCRNode
193
- "The path of the JCR node this object represents"
194
- path: String!
195
- "Get the primary node type of this node"
196
- primaryNodeType: JCRNodeType!
197
- "GraphQL representations of the properties in the requested language"
198
- properties(
199
- "Filter by graphQL fields values"
200
- fieldFilter: InputFieldFiltersInput,
201
- "The language to obtain the properties in; must be a valid language code in case any internationalized properties are requested, does not matter for non-internationalized ones"
202
- language: String,
203
- "The names of the JCR properties; null to obtain all properties"
204
- names: [String],
205
- "When set to true, returns the node in the default language if there is no translation for the requested language. Returns null if the option \"Replace untranslated content with the default language content\" is not activated for the site of the requested node. Will also return null if there is no translation for the default language."
206
- useFallbackLanguage: Boolean = false
207
- ): [JCRProperty]!
208
- "The GraphQL representation of the property in the requested language; null if the property does not exist"
209
- property(
210
- "The language to obtain the property in; must be a valid language code for internationalized properties, does not matter for non-internationalized ones"
211
- language: String,
212
- "The name of the JCR property"
213
- name: String!,
214
- "When set to true, returns the node in the default language if there is no translation for the requested language. Returns null if the option \"Replace untranslated content with the default language content\" is not activated for the site of the requested node. Will also return null if there is no translation for the default language."
215
- useFallbackLanguage: Boolean = false
216
- ): JCRProperty
217
- "Returns count of all references of the node across all sites"
218
- referenceCount(
219
- "Filter out referencing types which should not be counted"
220
- typesFilter: InputNodeTypesInput
221
- ): Int
222
- "GraphQL representations of the reference properties that target the current JCR Node"
223
- references(
224
- "fetching only nodes after this node (exclusive)"
225
- after: String,
226
- "fetching only nodes before this node (exclusive)"
227
- before: String,
228
- "Filter by graphQL fields values"
229
- fieldFilter: InputFieldFiltersInput,
230
- "Sort by graphQL fields values"
231
- fieldSorter: InputFieldSorterInput,
232
- "fetching only the first certain number of nodes"
233
- first: Int,
234
- "fetching only the last certain number of nodes"
235
- last: Int,
236
- "fetching only the first certain number of nodes"
237
- limit: Int,
238
- "fetching only nodes after this node (inclusive)"
239
- offset: Int
240
- ): JCRPropertyConnection!
241
- "Get render URL"
242
- renderUrl(
243
- "Finds displayable node"
244
- findDisplayable: Boolean = false,
245
- "The language content is rendered in"
246
- language: String!,
247
- "The target workspace"
248
- workspace: Workspace!
249
- ): String
250
- "Gets the fully rendered content for this node"
251
- renderedContent(
252
- "Rendering context configuration"
253
- contextConfiguration: String,
254
- "Is edit mode"
255
- isEditMode: Boolean,
256
- "Language"
257
- language: String,
258
- "Main resource path"
259
- mainResourcePath: String,
260
- "Additional request attributes"
261
- requestAttributes: [InputRenderRequestAttributeInput],
262
- "Template type"
263
- templateType: String,
264
- "Name of the view (leave null for default)"
265
- view: String
266
- ): RenderedNode
267
- "GraphQL representation of the site the JCR node belongs to, or the system site in case the node does not belong to any site"
268
- site: JCRSite
269
- "Get node thumbnail URL"
270
- thumbnailUrl(
271
- "Checks if requested thumbnail node exists"
272
- checkIfExists: Boolean = false,
273
- "Thumbnail name"
274
- name: String
275
- ): String
276
- "Returns languages of available translations for this node"
277
- translationLanguages(
278
- "Optional: Return languages only if it is active for the site"
279
- isActiveOnly: Boolean
280
- ): [String]
281
- "Get node URL"
282
- url: String
283
- "GraphQL representations of the reference properties that target the current JCR Node"
284
- usages(
285
- "fetching only nodes after this node (exclusive)"
286
- after: String,
287
- "fetching only nodes before this node (exclusive)"
288
- before: String,
289
- "Filter by graphQL fields values"
290
- fieldFilter: InputFieldFiltersInput,
291
- "Sort by graphQL fields values"
292
- fieldSorter: InputFieldSorterInput,
293
- "fetching only the first certain number of nodes"
294
- first: Int,
295
- "fetching only the last certain number of nodes"
296
- last: Int,
297
- "fetching only the first certain number of nodes"
298
- limit: Int,
299
- "fetching only nodes after this node (inclusive)"
300
- offset: Int
301
- ): UsageConnection!
302
- "The UUID of the JCR node this object represents"
303
- uuid: String!
304
- "Get vanity URLs from the current node filtered by the parameters"
305
- vanityUrls(
306
- "Filter results based on graphql field values"
307
- fieldFilter: InputFieldFiltersInput,
308
- "Languages"
309
- languages: [String]
310
- ): [VanityUrl]
311
- "Read work in progress information for a given node"
312
- wipInfo: wipInfo
313
- "Get the workspace of the query"
314
- workspace: Workspace!
315
- }
316
-
317
- "GraphQL representation of a principal"
318
- interface Principal {
319
- "Full display name"
320
- displayName: String
321
- "List of groups this principal belongs to"
322
- groupMembership(
323
- "fetching only nodes after this node (exclusive)"
324
- after: String,
325
- "fetching only nodes before this node (exclusive)"
326
- before: String,
327
- "Filter by graphQL fields values"
328
- fieldFilter: InputFieldFiltersInput,
329
- "Group fields according to specified criteria"
330
- fieldGrouping: InputFieldGroupingInput,
331
- "Sort by graphQL fields values"
332
- fieldSorter: InputFieldSorterInput,
333
- "fetching only the first certain number of nodes"
334
- first: Int,
335
- "fetching only the last certain number of nodes"
336
- last: Int,
337
- "fetching only the first certain number of nodes"
338
- limit: Int,
339
- "fetching only nodes after this node (inclusive)"
340
- offset: Int,
341
- "Return only groups which belong to this site"
342
- site: String
343
- ): GroupConnection!
344
- "Is this principal member of the specified group"
345
- memberOf(
346
- "Target group"
347
- group: String,
348
- "Site where the group is defined"
349
- site: String
350
- ): Boolean
351
- "Name"
352
- name: String!
353
- "Get the corresponding JCR node"
354
- node: JCRNode
355
- "Get principal type for this principal"
356
- principalType: PrincipalType
357
- "Site where the principal is defined"
358
- site: JCRSite
359
- }
360
-
361
- "GraphQL representation of a Jahia ACL role"
362
- type AclRole {
363
- "List of dependencies for a given role"
364
- dependencies: [AclRole]
365
- "Role description for a given locale"
366
- description(
367
- "locale"
368
- locale: String
369
- ): String
370
- "Role label for a given locale"
371
- label(
372
- "locale"
373
- locale: String
374
- ): String
375
- "Role name"
376
- name: String
377
- "Role group"
378
- roleGroup: String
379
- }
380
-
381
- "Admin mutations"
382
- type AdminMutation {
383
- "Get Jahia admin mutation"
384
- jahia: JahiaAdminMutation!
385
- "Mount point mutation extension API"
386
- mountPoint: GqlMountPointMutation
387
- "Personal API tokens mutations"
388
- personalApiTokens: PersonalApiTokensMutation
389
- }
390
-
391
- "Admin queries root"
392
- type AdminQuery {
393
- "Details about the Jahia cluster"
394
- cluster: Cluster
395
- "Current datetime"
396
- datetime: String
397
- "Get Jahia admin query"
398
- jahia: JahiaAdminQuery!
399
- "Mount point mutation extension API"
400
- mountPoint: GqlMountPointQuery
401
- "Personal API tokens queries"
402
- personalApiTokens: PersonalApiTokensQuery
403
- "Get available ACL roles; does not include any hidden or privileged roles"
404
- roles: [AclRole]
405
- "Jahia admin tools"
406
- tools: AdminTools
407
- "Get user administration endpoint"
408
- userAdmin: UserAdminQuery
409
- "Get user group endpoint"
410
- userGroup: UserGroupQuery
411
- "Version of the running Jahia instance"
412
- version: String! @deprecated(reason: "Deprecated")
413
- }
414
-
415
- "Jahia admin tools"
416
- type AdminTools {
417
- "Will return dependencies of a bundle (modules or packages)"
418
- findDependencies(
419
- "will return only dependencies of Jahia modules (not bundles)"
420
- ModulesOnly: Boolean = true,
421
- "will return only bundle name matching the RegExp"
422
- RegExp: String,
423
- "will return only dependencies with a strict version specified (a version that reprobates upgrade of minor ones)"
424
- StrictVersionOnly: Boolean = true
425
- ): FindDependencies
426
- "Will return all the duplicate export packages and the bundles that export them"
427
- findMatchingExportPackages(
428
- "will return only export-package matching the RegExp"
429
- RegExp: String,
430
- "will return only export-package found multiple times for a same package name"
431
- duplicates: Boolean = false
432
- ): FindExportPackage
433
- "Will return all the import packages matching the given parameters."
434
- findMatchingImportPackages(
435
- "will return only import-package matching the RegExp"
436
- RegExp: String,
437
- "will return only import-package matching the given version"
438
- version: String,
439
- "will return only import-package with no version range limitations"
440
- versionMissing: Boolean = false
441
- ): FindImportPackage
442
- }
443
-
444
- "Asset type for files"
445
- type Asset {
446
- "Asset metadata"
447
- metadata: Metadata
448
- "Asset size"
449
- size: Float
450
- "Mime type of the asset"
451
- type: String
452
- }
453
-
454
- "Result of the dependency inspector operation."
455
- type BundleDependency {
456
- "An error occurred during parsing dependency"
457
- error: String
458
- "The name of the dependency"
459
- name: String
460
- "The dependency is optional"
461
- optional: Boolean
462
- "The status of that dependency."
463
- status: String
464
- "The type of the dependency."
465
- type: String
466
- "The version of the dependency (can be a range, a number or empty)"
467
- version: String
468
- }
469
-
470
- "Result of the dependency inspector operation."
471
- type BundleWithDependencies {
472
- "Display name of the bundle."
473
- bundleDisplayName: String
474
- "ID of the bundle."
475
- bundleId: Long
476
- "Name of the bundle."
477
- bundleName: String
478
- "Symbolic name of the bundle."
479
- bundleSymbolicName: String
480
- "List of bundle dependencies (packages and modules)."
481
- dependencies: [BundleDependency]
482
- "Is module dependencies can be safely upgraded without breaking module wiring ?"
483
- dependenciesUpgradables: Boolean
484
- }
485
-
486
- "Result of the export package inspector operation."
487
- type BundleWithExportPackage {
488
- "Display name of the bundle."
489
- bundleDisplayName: String
490
- "ID of the bundle."
491
- bundleId: Long
492
- "Name of the bundle."
493
- bundleName: String
494
- "Symbolic name of the bundle."
495
- bundleSymbolicName: String
496
- "The full export-package clause."
497
- matchingExportPackage: String
498
- }
499
-
500
- "Result of the import package inspector operation."
501
- type BundleWithImportPackages {
502
- "Display name of the bundle."
503
- bundleDisplayName: String
504
- "ID of the bundle."
505
- bundleId: Long
506
- "Name of the bundle."
507
- bundleName: String
508
- "Symbolic name of the bundle."
509
- bundleSymbolicName: String
510
- "List of matching imported packages."
511
- matchingImportPackages: [String]
512
- }
513
-
514
- "Category type"
515
- type Category {
516
- "Description"
517
- description: String
518
- "Asset metadata"
519
- metadata: Metadata
520
- "Title"
521
- title: String
522
- }
523
-
524
- "Details about the Jahia Cluster"
525
- type Cluster {
526
- "Is the cluster mode activated on this Jahia instance"
527
- isActivated: Boolean
528
- "Query operation on Jahia's journal across all nodes of a cluster"
529
- journal: Journal
530
- }
531
-
532
- "Mutation for configuration value object"
533
- type ConfigurationItemValuesMutation {
534
- "Modify a list of items"
535
- mutateList(
536
- "property name part"
537
- name: String
538
- ): ConfigurationItemsListMutation
539
- "Modify a structured object"
540
- mutateObject(
541
- "property name part"
542
- name: String
543
- ): ConfigurationItemValuesMutation
544
- "Remove the specified property and all sub/list properties"
545
- remove(
546
- "property name part"
547
- name: String
548
- ): Boolean
549
- "Set a property value"
550
- value(
551
- "property name part"
552
- name: String,
553
- value: String
554
- ): String
555
- }
556
-
557
- "Query for configuration value object"
558
- type ConfigurationItemValuesQuery {
559
- "Get keys"
560
- keys: [String]
561
- "Get a list of items"
562
- list(
563
- "property name part"
564
- name: String
565
- ): ConfigurationItemsListQuery
566
- "Get a sub structured object value"
567
- object(
568
- "property name part"
569
- name: String
570
- ): ConfigurationItemValuesQuery
571
- "Get a property value"
572
- value(
573
- "property name part"
574
- name: String
575
- ): String
576
- "Get property values"
577
- values: [GqlConfigurationProperty]
578
- }
579
-
580
- "Mutation for configuration list of values"
581
- type ConfigurationItemsListMutation {
582
- "Adds a new sub list to the list"
583
- addList: ConfigurationItemsListMutation
584
- "Adds a new structured object to the list"
585
- addObject: ConfigurationItemValuesMutation
586
- "Adds a property value to the list"
587
- addValue(value: String): String
588
- }
589
-
590
- "Query for configuration list of values"
591
- type ConfigurationItemsListQuery {
592
- "Get sub lists of items"
593
- lists: [ConfigurationItemsListQuery]
594
- "Get sub structured object values"
595
- objects: [ConfigurationItemValuesQuery]
596
- "Adds a new structured object to the list"
597
- size: Int
598
- "Get property values"
599
- values: [String]
600
- }
601
-
602
- "Simple node count aggregation"
603
- type CountAggregation {
604
- "Count all values"
605
- values(
606
- "The language to obtain the property in; must be a valid language code for internationalized properties, does not matter for non-internationalized ones"
607
- language: String,
608
- "The name of the JCR property"
609
- name: String!
610
- ): Int
611
- }
612
-
613
- "GraphQL representation of a Jahia current user"
614
- type Current_32_user {
615
- "Full display name"
616
- displayName: String
617
- "Email of the user"
618
- email: String
619
- "First name of the user"
620
- firstname: String
621
- "Preferred language by the user"
622
- language: String
623
- "Last name of the user"
624
- lastname: String
625
- "Displays if user is locked"
626
- locked: Boolean
627
- "Is this principal member of the specified group"
628
- memberOf(
629
- "Target group"
630
- group: String,
631
- "Site where the group is defined"
632
- site: String
633
- ): Boolean
634
- "User name"
635
- name: String! @deprecated(reason: "Deprecated")
636
- "Get the corresponding JCR node"
637
- node: JCRNode
638
- "User organization"
639
- organization: String
640
- "User property"
641
- property(
642
- "The name of the property"
643
- name: String!
644
- ): String
645
- "Site where the user is defined"
646
- site: JCRSite
647
- "Username of the user"
648
- username: String!
649
- }
650
-
651
- "Result of the export package inspector operation."
652
- type ExportPackages {
653
- "Flat list of exported packages"
654
- matchingExportPackages: [String]
655
- "The bundles that export the package."
656
- matchingExportPackagesDetailed: [BundleWithExportPackage]
657
- "the package name."
658
- packageName: String
659
- }
660
-
661
- "Result of the dependency inspector operation."
662
- type FindDependencies {
663
- "List of matching bundles."
664
- bundles: [BundleWithDependencies]
665
- "Total number of dependencies."
666
- totalCount: Int
667
- }
668
-
669
- "Result of the export package inspector operation."
670
- type FindExportPackage {
671
- "List of matching packages"
672
- packages: [ExportPackages]
673
- "Total number of matching export packages."
674
- totalCount: Int
675
- }
676
-
677
- "Result of the import package inspector operation."
678
- type FindImportPackage {
679
- "List of matching bundles."
680
- bundles: [BundleWithImportPackages]
681
- "Total number of matching import packages."
682
- totalCount: Int
683
- }
684
-
685
- "GraphQL representation of a generic JCR node"
686
- type GenericJCRNode implements JCRNode {
687
- "Get ACL info for this node"
688
- acl: GqlAcl
689
- "Get the last modified date of this node and its descendants. The recursion in descendants can be controlled by recursionTypesFilter. If no filter is passed, recursion will stop by default on sub pages."
690
- aggregatedLastModifiedDate(
691
- "The language"
692
- language: String,
693
- "Stop recursion on graphql field values"
694
- recursionTypesFilter: InputNodeTypesInput
695
- ): String
696
- "Aggregated publication info about the JCR node"
697
- aggregatedPublicationInfo(
698
- "Publication language"
699
- language: String!,
700
- "Whether to take references into account when calculating the aggregated publication status"
701
- references: Boolean = false,
702
- "Whether to take sub-nodes into account when calculating the aggregated publication status"
703
- subNodes: Boolean = false
704
- ): GqlPublicationInfo!
705
- "Render URL in ajax mode"
706
- ajaxRenderUrl: String
707
- "Returns a list of types allowed under the provided node"
708
- allowedChildNodeTypes(
709
- "Filter by GraphQL fields values"
710
- fieldFilter: InputFieldFiltersInput,
711
- "Whether all sub-types of allowed child node types should be included"
712
- includeSubTypes: Boolean = true
713
- ): [JCRNodeType]
714
- "GraphQL representations of the ancestor nodes of the JCR node, top down direction"
715
- ancestors(
716
- "Filter by graphQL fields values"
717
- fieldFilter: InputFieldFiltersInput,
718
- "The path of the topmost ancestor node to include in the result; null or empty string to include all the ancestor nodes"
719
- upToPath: String
720
- ): [JCRNode]!
721
- "GraphQL representations of the child nodes, according to parameters passed"
722
- children(
723
- "fetching only nodes after this node (exclusive)"
724
- after: String,
725
- "fetching only nodes before this node (exclusive)"
726
- before: String,
727
- "Filter by graphQL fields values"
728
- fieldFilter: InputFieldFiltersInput,
729
- "Group fields according to specified criteria"
730
- fieldGrouping: InputFieldGroupingInput,
731
- "Sort by graphQL fields values"
732
- fieldSorter: InputFieldSorterInput,
733
- "fetching only the first certain number of nodes"
734
- first: Int,
735
- "Include the current node itself in results"
736
- includesSelf: Boolean = false,
737
- "fetching only the last certain number of nodes"
738
- last: Int,
739
- "fetching only the first certain number of nodes"
740
- limit: Int,
741
- "Filter of child nodes by their names; null to avoid such filtering"
742
- names: [String],
743
- "fetching only nodes after this node (inclusive)"
744
- offset: Int,
745
- "Filter of child nodes by their property values; null to avoid such filtering"
746
- propertiesFilter: InputNodePropertiesInput,
747
- "Filter of child nodes by their types; null to avoid such filtering"
748
- typesFilter: InputNodeTypesInput,
749
- "Language to use to get children"
750
- validInLanguage: String
751
- ): JCRNodeConnection
752
- "Read default Work in progress information. Set by \"wip.checkbox.checked\" system proprety"
753
- defaultWipInfo: wipInfo
754
- "Returns the node definition that applies to this node."
755
- definition: JCRNodeDefinition
756
- "The depth in the JCR Tree of the JCR node this object represents"
757
- depth: Int!
758
- "GraphQL representation of a descendant node, based on its relative path"
759
- descendant(
760
- "Name or relative path of the sub node"
761
- relPath: String!
762
- ): JCRNode
763
- "GraphQL representations of the descendant nodes, according to parameters passed"
764
- descendants(
765
- "fetching only nodes after this node (exclusive)"
766
- after: String,
767
- "fetching only nodes before this node (exclusive)"
768
- before: String,
769
- "Filter by graphQL fields values"
770
- fieldFilter: InputFieldFiltersInput,
771
- "Group fields according to specified criteria"
772
- fieldGrouping: InputFieldGroupingInput,
773
- "Sort by graphQL fields values"
774
- fieldSorter: InputFieldSorterInput,
775
- "fetching only the first certain number of nodes"
776
- first: Int,
777
- "fetching only the last certain number of nodes"
778
- last: Int,
779
- "fetching only the first certain number of nodes"
780
- limit: Int,
781
- "Maximum depth in JCR tree for descendants from the current node, 0 (or less) for all sub nodes, 1 for one sub level, etc"
782
- maxDepth: Int,
783
- "fetching only nodes after this node (inclusive)"
784
- offset: Int,
785
- "Filter of descendant nodes by their property values; null to avoid such filtering"
786
- propertiesFilter: InputNodePropertiesInput,
787
- "Filter out and stop recursion on nodes by their property values; null to avoid such filtering"
788
- recursionPropertiesFilter: InputNodePropertiesInput,
789
- "Filter out and stop recursion on nodes by their types; null to avoid such filtering"
790
- recursionTypesFilter: InputNodeTypesInput,
791
- "Filter of descendant nodes by their types; null to avoid such filtering"
792
- typesFilter: InputNodeTypesInput,
793
- "Language to use to get children"
794
- validInLanguage: String
795
- ): JCRNodeConnection
796
- "The displayable name of the JCR node"
797
- displayName(
798
- "Language"
799
- language: String
800
- ): String
801
- "Returns the first parent of the current node that can be displayed in full page. If no matching node is found, null is returned."
802
- displayableNode: JCRNode
803
- "Returns the next available name for a node, appending if needed numbers."
804
- findAvailableNodeName(language: String, nodeType: String): String
805
- "Check if the current user has a specific permission"
806
- hasPermission(
807
- "The name of the permission"
808
- permissionName: String!
809
- ): Boolean
810
- "Check if the node as a renderable template associated with it (not a view a template)."
811
- isDisplayableNode: Boolean
812
- "true if node is under a mounted node"
813
- isExternal: Boolean!
814
- "Reports if the current node matches the nodetype(s) passed in parameter"
815
- isNodeType(
816
- "Node type name"
817
- type: InputNodeTypesInput!
818
- ): Boolean!
819
- "Check if the given locales need translation, by comparing last modifications dates with already existing translations"
820
- languagesToTranslate(
821
- "The languages to check"
822
- languagesToCheck: [String],
823
- "The translated languages"
824
- languagesTranslated: [String]
825
- ): [String]
826
- "Retrieve lock info of the current node"
827
- lockInfo: LockInfo
828
- "Returns edit lock status of the current node object"
829
- lockedAndCannotBeEdited: Boolean
830
- "Returns an array of <code>NodeType</code> objects representing the mixin node types in effect for this node."
831
- mixinTypes(
832
- "Filter by GraphQL fields values"
833
- fieldFilter: InputFieldFiltersInput
834
- ): [JCRNodeType]!
835
- "The name of the JCR node this object represents"
836
- name: String!
837
- "GraphQL representation of this node in certain workspace"
838
- nodeInWorkspace(
839
- "The target workspace"
840
- workspace: Workspace!
841
- ): JCRNode
842
- "Get information on the operations that can be done on this node"
843
- operationsSupport: GqlOperationsSupport
844
- "GraphQL representation of the parent JCR node"
845
- parent: JCRNode
846
- "The path of the JCR node this object represents"
847
- path: String!
848
- "Get the primary node type of this node"
849
- primaryNodeType: JCRNodeType!
850
- "GraphQL representations of the properties in the requested language"
851
- properties(
852
- "Filter by graphQL fields values"
853
- fieldFilter: InputFieldFiltersInput,
854
- "The language to obtain the properties in; must be a valid language code in case any internationalized properties are requested, does not matter for non-internationalized ones"
855
- language: String,
856
- "The names of the JCR properties; null to obtain all properties"
857
- names: [String],
858
- "When set to true, returns the node in the default language if there is no translation for the requested language. Returns null if the option \"Replace untranslated content with the default language content\" is not activated for the site of the requested node. Will also return null if there is no translation for the default language."
859
- useFallbackLanguage: Boolean = false
860
- ): [JCRProperty]!
861
- "The GraphQL representation of the property in the requested language; null if the property does not exist"
862
- property(
863
- "The language to obtain the property in; must be a valid language code for internationalized properties, does not matter for non-internationalized ones"
864
- language: String,
865
- "The name of the JCR property"
866
- name: String!,
867
- "When set to true, returns the node in the default language if there is no translation for the requested language. Returns null if the option \"Replace untranslated content with the default language content\" is not activated for the site of the requested node. Will also return null if there is no translation for the default language."
868
- useFallbackLanguage: Boolean = false
869
- ): JCRProperty
870
- "Returns count of all references of the node across all sites"
871
- referenceCount(
872
- "Filter out referencing types which should not be counted"
873
- typesFilter: InputNodeTypesInput
874
- ): Int
875
- "GraphQL representations of the reference properties that target the current JCR Node"
876
- references(
877
- "fetching only nodes after this node (exclusive)"
878
- after: String,
879
- "fetching only nodes before this node (exclusive)"
880
- before: String,
881
- "Filter by graphQL fields values"
882
- fieldFilter: InputFieldFiltersInput,
883
- "Sort by graphQL fields values"
884
- fieldSorter: InputFieldSorterInput,
885
- "fetching only the first certain number of nodes"
886
- first: Int,
887
- "fetching only the last certain number of nodes"
888
- last: Int,
889
- "fetching only the first certain number of nodes"
890
- limit: Int,
891
- "fetching only nodes after this node (inclusive)"
892
- offset: Int
893
- ): JCRPropertyConnection!
894
- "Get render URL."
895
- renderUrl(
896
- "Finds displayable node"
897
- findDisplayable: Boolean = false,
898
- "The language content is rendered in"
899
- language: String!,
900
- "The target workspace"
901
- workspace: Workspace!
902
- ): String
903
- "Gets the fully rendered content for this node"
904
- renderedContent(
905
- "Rendering context configuration"
906
- contextConfiguration: String,
907
- "Is edit mode"
908
- isEditMode: Boolean,
909
- "Language"
910
- language: String,
911
- "Main resource path"
912
- mainResourcePath: String,
913
- "Additional request attributes"
914
- requestAttributes: [InputRenderRequestAttributeInput],
915
- "Template type"
916
- templateType: String,
917
- "Name of the view (leave null for default)"
918
- view: String
919
- ): RenderedNode
920
- "GraphQL representation of the site the JCR node belongs to, or the system site in case the node does not belong to any site"
921
- site: JCRSite
922
- "Get node thumbnail URL"
923
- thumbnailUrl(
924
- "Optional: Checks if requested thumbnail node exists, returns null if it doesn't"
925
- checkIfExists: Boolean = false,
926
- "Thumbnail name"
927
- name: String
928
- ): String
929
- "Returns languages of available translations for this node"
930
- translationLanguages(
931
- "Optional: Return languages only if it is active for the site"
932
- isActiveOnly: Boolean
933
- ): [String]
934
- "Get node URL"
935
- url: String
936
- "GraphQL representations of the reference properties that target the current JCR Node"
937
- usages(
938
- "fetching only nodes after this node (exclusive)"
939
- after: String,
940
- "fetching only nodes before this node (exclusive)"
941
- before: String,
942
- "Filter by graphQL fields values"
943
- fieldFilter: InputFieldFiltersInput,
944
- "Sort by graphQL fields values"
945
- fieldSorter: InputFieldSorterInput,
946
- "fetching only the first certain number of nodes"
947
- first: Int,
948
- "fetching only the last certain number of nodes"
949
- last: Int,
950
- "fetching only the first certain number of nodes"
951
- limit: Int,
952
- "fetching only nodes after this node (inclusive)"
953
- offset: Int
954
- ): UsageConnection!
955
- "The UUID of the JCR node this object represents"
956
- uuid: String!
957
- "Get vanity URLs from the current node filtered by the parameters"
958
- vanityUrls(
959
- "Filter results based on graphql field values"
960
- fieldFilter: InputFieldFiltersInput,
961
- "Languages"
962
- languages: [String]
963
- ): [VanityUrl]
964
- "Read work in progress information for a given node"
965
- wipInfo: wipInfo
966
- "Get the workspace of the query"
967
- workspace: Workspace!
968
- }
969
-
970
- "ACL properties and list of access control entry"
971
- type GqlAcl {
972
- "Get list of access control entries for this ACL"
973
- aclEntries(
974
- "The languages to check"
975
- inclInherited: Boolean,
976
- "Fetch ACL entry only for this principal"
977
- principalFilter: InputPrincipalInput
978
- ): [GqlAclEntry]
979
- "Get inheritance break attribute for this node"
980
- inheritanceBreak: Boolean
981
- "Get parent node for this ACL"
982
- parentNode: JCRNode
983
- }
984
-
985
- "ACL entry"
986
- type GqlAclEntry {
987
- "Type of access for this ACL entry - one of GRANT, DENY or EXTERNAL"
988
- aclEntryType: String
989
- "External permissions name "
990
- externalPermissionsName: String
991
- "Return true if this ACL entry did not originate from this ACL's parent node"
992
- inherited: Boolean
993
- "Get node where this ACL entry originated from"
994
- inheritedFrom: JCRNode
995
- "Get principal for this entry"
996
- principal: Principal
997
- "Get role for this entry"
998
- role: AclRole
999
- }
1000
-
1001
- "Background job"
1002
- type GqlBackgroundJob {
1003
- "The amount of time the job ran for (in milliseconds). The returned value will be -1 until the job has actually completed"
1004
- duration: Long
1005
- "The job group name"
1006
- group: String
1007
- "The job (Boolean) property that correspond to the given name. The returned value will be null in case the job doesn't have the property"
1008
- jobBooleanProperty(
1009
- "The name of the property"
1010
- name: String
1011
- ): Boolean
1012
- "Job description"
1013
- jobDescription: String
1014
- "The job (Int) property that correspond to the given name. The returned value will be null in case the job doesn't have the property"
1015
- jobIntegerProperty(
1016
- "The name of the property"
1017
- name: String
1018
- ): Int
1019
- "The job (Long) property that correspond to the given name. The returned value will be null in case the job doesn't have the property"
1020
- jobLongProperty(
1021
- "The name of the property"
1022
- name: String
1023
- ): Long
1024
- "The job state is different from the status, it reflect the last action done on the job instance (Started, Vetoed, Finished)"
1025
- jobState: GqlBackgroundJobState
1026
- "The job status"
1027
- jobStatus: GqlBackgroundJobStatus
1028
- "List of strings property from the job map (eg. publicationInfos, publicationPaths)"
1029
- jobStringListProperty(
1030
- "The name of the property"
1031
- name: String
1032
- ): [String]
1033
- "The job (String) property that correspond to the given name. The returned value will be null in case the job doesn't have the property"
1034
- jobStringProperty(
1035
- "The name of the property"
1036
- name: String
1037
- ): String
1038
- "The name of the property"
1039
- name: String
1040
- "GraphQL representation of publication job"
1041
- publicationJob: GqlPublicationBackgroundJob
1042
- "The site key. The returned value will be null in case the job doesn't have associated site key"
1043
- siteKey: String
1044
- "The user key. The returned value will be null in case the job doesn't have associated user key"
1045
- userKey: String
1046
- }
1047
-
1048
- "A connection to a list of items."
1049
- type GqlBackgroundJobConnection {
1050
- "a list of edges"
1051
- edges: [GqlBackgroundJobEdge]
1052
- "a list of nodes"
1053
- nodes: [GqlBackgroundJob]
1054
- "details about this specific page"
1055
- pageInfo: PageInfo!
1056
- }
1057
-
1058
- "An edge in a connection"
1059
- type GqlBackgroundJobEdge {
1060
- "cursor marks a unique position or index into the connection"
1061
- cursor: String!
1062
- "index in the connection"
1063
- index: Int
1064
- "The item at the end of the edge"
1065
- node: GqlBackgroundJob
1066
- }
1067
-
1068
- "Channel information"
1069
- type GqlChannel {
1070
- "Channel label (not localized)"
1071
- displayName: String
1072
- "Return true if channel is visible, otherwise false"
1073
- isVisible: Boolean
1074
- "Channel name/identifier"
1075
- name: String
1076
- "Return variants for this channel, if available"
1077
- variants: [GqlVariant]
1078
- }
1079
-
1080
- "Condition for override item"
1081
- type GqlCondition {
1082
- "Item will apply only on this nodetype"
1083
- nodeType: String
1084
- "Item will apply only if node has orderable children"
1085
- orderable: Boolean
1086
- "Item will apply only if user has permissions"
1087
- withPermission: String
1088
- "Item will apply only if user has not permissions"
1089
- withoutPermission: String
1090
- }
1091
-
1092
- "Mutation for OSGi configuration"
1093
- type GqlConfigurationMutation {
1094
- "Modify a list of items"
1095
- mutateList(
1096
- "property name part"
1097
- name: String
1098
- ): ConfigurationItemsListMutation
1099
- "Modify a structured object"
1100
- mutateObject(
1101
- "property name part"
1102
- name: String
1103
- ): ConfigurationItemValuesMutation
1104
- "Remove the specified property and all sub/list properties"
1105
- remove(
1106
- "property name part"
1107
- name: String
1108
- ): Boolean
1109
- "Set a property value"
1110
- value(
1111
- "property name part"
1112
- name: String,
1113
- value: String
1114
- ): String
1115
- }
1116
-
1117
- "OSGi configuration property"
1118
- type GqlConfigurationProperty {
1119
- "The property key"
1120
- key: String
1121
- "The property value"
1122
- value: String
1123
- }
1124
-
1125
- "Query for OSGi configuration"
1126
- type GqlConfigurationQuery {
1127
- "Get all properties of the configuration, as they are stored in OSGi"
1128
- flatKeys: [String]
1129
- "Get all properties of the configuration, as they are stored in OSGi"
1130
- flatProperties: [GqlConfigurationProperty]
1131
- "Get keys"
1132
- keys: [String]
1133
- "Get a list of items"
1134
- list(
1135
- "property name part"
1136
- name: String
1137
- ): ConfigurationItemsListQuery
1138
- "Get a sub structured object value"
1139
- object(
1140
- "property name part"
1141
- name: String
1142
- ): ConfigurationItemValuesQuery
1143
- "Get a property value"
1144
- value(
1145
- "property name part"
1146
- name: String
1147
- ): String
1148
- "Get property values"
1149
- values: [GqlConfigurationProperty]
1150
- }
1151
-
1152
- type GqlDashboard {
1153
- "Retrieves the list of modules currently available on the platform"
1154
- modules: [GqlModule]
1155
- "Whether the tools are accessible on the installation"
1156
- toolsAccess: Boolean
1157
- }
1158
-
1159
- type GqlEditorForm {
1160
- "Retrieve a description text for the form, might contain explanations on how to use the form"
1161
- description: String
1162
- "Retrieve the displayable name of the form (in a specific language)"
1163
- displayName: String
1164
- "Returns the preview status of the form. If true, the form can display a preview."
1165
- hasPreview: Boolean
1166
- "Get list of merged forms."
1167
- mergedItems(
1168
- "Filter on field values"
1169
- filter: InputFieldFiltersInput
1170
- ): [GqlMergedItem]
1171
- "Retrieve the name (aka identifier) of the form"
1172
- name: String
1173
- "Retrieve the sections that make up the form"
1174
- sections: [GqlEditorFormSection]
1175
- "Returns the advanced mode status of the form. If true advanced mode is available."
1176
- showAdvancedMode: Boolean
1177
- }
1178
-
1179
- type GqlEditorFormField {
1180
- "The declaring node type for the field"
1181
- declaringNodeType: String
1182
- "This value contains the default values for the field."
1183
- defaultValues: [GqlEditorFormValue]
1184
- "The description of the field"
1185
- description: String
1186
- "The displayable name of the field"
1187
- displayName: String
1188
- "The error message of the field"
1189
- errorMessage: String
1190
- "This value is true if the field allows for internationalized values"
1191
- i18n: Boolean
1192
- "This value is true if the field is mandatory"
1193
- mandatory: Boolean
1194
- "This value is true if the field value is multi-valued."
1195
- multiple: Boolean
1196
- "The name of the field"
1197
- name: String
1198
- "This value is true if the field is readonly. This could be due to locks or permissions"
1199
- readOnly: Boolean
1200
- "The required type for the field"
1201
- requiredType: JCRPropertyType
1202
- "Options for the selector type. For JCR definitions, this will usually include choicelist initializer name and properties."
1203
- selectorOptions: [GqlEditorFormProperty]
1204
- "The selector type for the field. In the case of fields generated from node types, this is actually the SelectorType."
1205
- selectorType: String
1206
- "This array contains the list of possible values to choose from"
1207
- valueConstraints: [GqlEditorFormValueConstraint]
1208
- "This fields set is visible"
1209
- visible: Boolean
1210
- }
1211
-
1212
- type GqlEditorFormFieldSet {
1213
- "Only used in the case of a dynamic field set. Set to true if it is activated"
1214
- activated: Boolean
1215
- "Get the internationalized description of the field set"
1216
- description: String
1217
- "Get the internationalized displayable name of the field set"
1218
- displayName: String
1219
- "True if this is dynamic field set (meaning it can be activated or not)"
1220
- dynamic: Boolean
1221
- "Get the fields contained in the target"
1222
- fields: [GqlEditorFormField]
1223
- "Only used in the case of a dynamic field set. Set to true if it is activated"
1224
- hasEnableSwitch: Boolean
1225
- "Get the name of the field set"
1226
- name: String
1227
- "This value is true if the fieldset is readonly. This could be due to locks or permissions"
1228
- readOnly: Boolean
1229
- visible: Boolean
1230
- }
1231
-
1232
- type GqlEditorFormMutations {
1233
- "Publish the edited node with the associated technical sub nodes (visibility conditions, vanity urls, ACLs)"
1234
- publishForm(
1235
- "A string representation of a locale, in IETF BCP 47 language tag format, ie en_US, en, fr, fr_CH, ..."
1236
- locale: String!,
1237
- "UUID or path of the edited node."
1238
- uuidOrPath: String!
1239
- ): Boolean
1240
- "Unlock the given node for edition, if the node is locked."
1241
- unlockEditor(
1242
- "An ID generated client side used to identify the lock"
1243
- editorID: String!
1244
- ): Boolean
1245
- }
1246
-
1247
- type GqlEditorFormProperty {
1248
- "Property name"
1249
- name: String
1250
- "Property value"
1251
- value: String
1252
- "Property values"
1253
- values: [String]
1254
- }
1255
-
1256
- type GqlEditorFormSection {
1257
- "Returns the description of the section"
1258
- description: String
1259
- "Retrieve the displayable name of the section"
1260
- displayName: String
1261
- "Is the section expanded"
1262
- expanded: Boolean
1263
- "Returns the field sets contained in this section"
1264
- fieldSets: [GqlEditorFormFieldSet]
1265
- "Retrieve the name (aka identifier) of the section"
1266
- name: String
1267
- "This section is visible"
1268
- visible: Boolean
1269
- }
1270
-
1271
- type GqlEditorFormValue {
1272
- "This value's string representation"
1273
- string: String
1274
- "The type of this value"
1275
- type: String
1276
- }
1277
-
1278
- type GqlEditorFormValueConstraint {
1279
- "The value as it is intended to be displayed in UIs"
1280
- displayValue: String
1281
- "The key of the value to get the translated value from the client side"
1282
- displayValueKey: String
1283
- "The properties for the value"
1284
- properties: [GqlEditorFormProperty]
1285
- "The actual value to be used in storage"
1286
- value: GqlEditorFormValue
1287
- }
1288
-
1289
- type GqlEditorForms {
1290
- "Retrieve the custom configuration path for CKEditor"
1291
- ckeditorConfigPath(
1292
- "node path"
1293
- nodePath: String
1294
- ): String
1295
- "Retrieve the toolbar type for CKEditor"
1296
- ckeditorToolbar(
1297
- "node path"
1298
- nodePath: String
1299
- ): String
1300
- "Get a list of allowed child nodeTypes for a given nodeType and path. (Note that it returns nothing for type [jnt:page]. [jnt:contentFolder] is filterered by [jmix:editorialContent])"
1301
- contentTypesAsTree(
1302
- "the child node name, used to check the type allowed for this named child node, do not specify if you want to check for unnamed children"
1303
- childNodeName: String,
1304
- "List of types we want to exclude, null for all"
1305
- excludedNodeTypes: [String],
1306
- "if true, retrieves all the sub types of the given node types, if false, returns the type only. Default value is true"
1307
- includeSubTypes: Boolean = true,
1308
- "List of types we want to retrieve, null for all"
1309
- nodeTypes: [String],
1310
- "A string representation of a locale, in IETF BCP 47 language tag format, ie en_US, en, fr, fr_CH, ..."
1311
- uiLocale: String!,
1312
- "if true, check the contribute property of the node. Default value is true"
1313
- useContribute: Boolean = true,
1314
- "Path or id of an existing node under with the new content will be created."
1315
- uuidOrPath: String!
1316
- ): [NodeTypeTreeEntry]
1317
- "Get a editor form to create a new content from its nodetype and parent"
1318
- createForm(
1319
- "A string representation of a locale, in IETF BCP 47 language tag format, ie en_US, en, fr, fr_CH, ..."
1320
- locale: String!,
1321
- "The primary node type name identifying the form we want to retrieve"
1322
- primaryNodeType: String!,
1323
- "A string representation of a locale, in IETF BCP 47 language tag format, ie en_US, en, fr, fr_CH, ..."
1324
- uiLocale: String!,
1325
- "uuid or path of an existing node under with the new content will be created."
1326
- uuidOrPath: String!
1327
- ): GqlEditorForm
1328
- "Get a editor form from a locale and an existing node"
1329
- editForm(
1330
- "A string representation of a locale, in IETF BCP 47 language tag format, ie en_US, en, fr, fr_CH, ..."
1331
- locale: String!,
1332
- "A string representation of a locale, in IETF BCP 47 language tag format, ie en_US, en, fr, fr_CH, ..."
1333
- uiLocale: String!,
1334
- "UUID or path of an existing node under with the new content will be created."
1335
- uuidOrPath: String!
1336
- ): GqlEditorForm
1337
- "Get field constraints"
1338
- fieldConstraints(
1339
- "Object contains additional information of the node"
1340
- context: [InputContextEntryInput],
1341
- "A string representation of field name"
1342
- fieldName: String!,
1343
- "A string representation of the field node type (the node type that contains the field, can be the node type of the node, a mixin or a super type)"
1344
- fieldNodeType: String!,
1345
- "A string representation of a locale, in IETF BCP 47 language tag format, ie en_US, en, fr, fr_CH, ..."
1346
- locale: String!,
1347
- "UUID or path of the node (optional in case you are creating it, and it doesnt exist yet)"
1348
- nodeUuidOrPath: String,
1349
- "UUID or path of the parent node"
1350
- parentNodeUuidOrPath: String!,
1351
- "A string representation of the primary node type of the node"
1352
- primaryNodeType: String!,
1353
- "A string representation of a locale, in IETF BCP 47 language tag format, ie en_US, en, fr, fr_CH, ..."
1354
- uiLocale: String!
1355
- ): [GqlEditorFormValueConstraint]
1356
- "Retrieve the number of sub contents under the node for given types"
1357
- subContentsCount(
1358
- "List of node types to check for"
1359
- includeTypes: [String],
1360
- "Limit of sub contents count"
1361
- limit: Int,
1362
- "node path"
1363
- nodePath: String
1364
- ): Int
1365
- }
1366
-
1367
- "Server healthCheck"
1368
- type GqlHealthCheck {
1369
- "Probes registered in SAM for the requested severity"
1370
- probes(
1371
- "Return probes matching this status or above"
1372
- health: GqlProbeHealth
1373
- ): [GqlProbe]
1374
- "Highest reported status across all probes"
1375
- status: GqlProbeStatus
1376
- }
1377
-
1378
- "jContent API"
1379
- type GqlJContent {
1380
- "Returns all available channels"
1381
- channels: [GqlChannel]
1382
- "Returns html with marked differences"
1383
- diffHtml(
1384
- "New html"
1385
- newHtml: String,
1386
- "Original html"
1387
- originalHtml: String
1388
- ): String
1389
- }
1390
-
1391
- "jContent API"
1392
- type GqlJContentMutations {
1393
- "Flushes cache for a page, checks adminCache permission and node type"
1394
- flushPageCache(
1395
- "Page path"
1396
- pagePath: String!
1397
- ): Boolean
1398
- "Flushes cache for a site, will resolve site node if the path supplied is not a site, checks adminCache permission"
1399
- flushSiteCache(
1400
- "Site path"
1401
- sitePath: String!
1402
- ): Boolean
1403
- }
1404
-
1405
- type GqlJcrImageTransformMutation {
1406
- "Crop an image under the current node"
1407
- cropImage(
1408
- "new height"
1409
- height: Int!,
1410
- "left"
1411
- left: Int!,
1412
- "top"
1413
- top: Int!,
1414
- "new width"
1415
- width: Int!
1416
- ): Boolean
1417
- "The transformed node"
1418
- node: JCRNode
1419
- "Resize an image under the current node"
1420
- resizeImage(
1421
- "new height"
1422
- height: Int!,
1423
- "new width"
1424
- width: Int!
1425
- ): Boolean
1426
- "Rotate an image under the current node"
1427
- rotateImage(
1428
- "angle in degrees"
1429
- angle: Float!
1430
- ): Boolean
1431
- }
1432
-
1433
- "Details on a lock"
1434
- type GqlLockDetail {
1435
- "Language"
1436
- language: String
1437
- "Lock owner"
1438
- owner: String
1439
- "Lock type"
1440
- type: String
1441
- }
1442
-
1443
- "Override item"
1444
- type GqlMergedItem {
1445
- "Name of the bundle owning this file"
1446
- bundleName: String
1447
- "Conditions set on this form/fieldset"
1448
- condition: GqlCondition
1449
- "Get field set detail, if item is a field set"
1450
- fieldSet: GqlEditorFormFieldSet
1451
- "File name and path"
1452
- filename: String
1453
- "Get form detail, if item is a form"
1454
- form: GqlEditorForm
1455
- "Override priority"
1456
- priority: Float
1457
- }
1458
-
1459
- type GqlModule {
1460
- "User facing description for the module"
1461
- description: String
1462
- "Unique identifier for the module"
1463
- id: String
1464
- "If the module is in development, mostly because the sources have been downloaded."
1465
- inDevelopment: Boolean
1466
- "Bundle last modification date"
1467
- lastModified: Long
1468
- "User facing name for the module"
1469
- name: String
1470
- "Version number for the module"
1471
- version: String
1472
- }
1473
-
1474
- "Mount point object"
1475
- type GqlMountPoint {
1476
- "Mount point name"
1477
- mountName: String
1478
- "Mount point local reference path"
1479
- mountPointRefPath: String
1480
- "Mount status"
1481
- mountStatus: String
1482
- "Mount node type"
1483
- nodeType: String
1484
- "Mount point additional properties"
1485
- properties: [GqlMountPointProperty]
1486
- "Mount point property"
1487
- property(
1488
- "The name of the property"
1489
- name: String!
1490
- ): String
1491
- "Mount point node uuid"
1492
- uuid: String
1493
- }
1494
-
1495
- "Mount point mutation object"
1496
- type GqlMountPointMutation {
1497
- "Create a mounted mount point node in /mounts"
1498
- add(
1499
- "Target local mount point"
1500
- mountPointRefPath: String,
1501
- "Mount point name"
1502
- name: String!
1503
- ): String
1504
- "Create a mounted VFS mount point node in /mounts"
1505
- addVfs(
1506
- "Target local mount point"
1507
- mountPointRefPath: String,
1508
- "Name for the mount point"
1509
- name: String!,
1510
- "VFS root mount point"
1511
- rootPath: String
1512
- ): String
1513
- "Modify an existing mount point node"
1514
- modify(
1515
- "Change local mount point, or set to empty string to remove"
1516
- mountPointRefPath: String,
1517
- "Rename existing mount point"
1518
- name: String,
1519
- "Mount point path or ID to modify"
1520
- pathOrId: String!
1521
- ): Boolean
1522
- "Modify an existing mount point node"
1523
- modifyVfs(
1524
- "Change target local mount point, or set to empty string to remove"
1525
- mountPointRefPath: String,
1526
- "Rename existing mount point"
1527
- name: String,
1528
- "Mount point path or ID to modify"
1529
- pathOrId: String!,
1530
- "VFS root mount point"
1531
- rootPath: String
1532
- ): Boolean
1533
- "Mount an existing mount point"
1534
- mount(
1535
- "Mount point path or ID to mount"
1536
- pathOrId: String!
1537
- ): Boolean
1538
- "Unmount an existing mount point"
1539
- unmount(
1540
- "Mount point path or ID to unmount"
1541
- pathOrId: String!
1542
- ): Boolean
1543
- }
1544
-
1545
- "Mount point property"
1546
- type GqlMountPointProperty {
1547
- "The property key"
1548
- key: String
1549
- "The property value"
1550
- value: String
1551
- }
1552
-
1553
- "Mount point queries object"
1554
- type GqlMountPointQuery {
1555
- "Get mount point with given name, or null if it doesn't exists"
1556
- mountPoint(
1557
- "Name for the mount point"
1558
- name: String!
1559
- ): GqlMountPoint
1560
- "Get list of mount points, or empty list if no mounts exist"
1561
- mountPoints: [GqlMountPoint]
1562
- }
1563
-
1564
- "Possible operations on a node"
1565
- type GqlOperationsSupport {
1566
- "Can node be locked"
1567
- lock: Boolean
1568
- "Can node be marked for deletion"
1569
- markForDeletion: Boolean
1570
- "does the node supports publication"
1571
- publication: Boolean!
1572
- }
1573
-
1574
- "Probes registered with SAM"
1575
- type GqlProbe {
1576
- "Description specified by the developer of the probe"
1577
- description: String
1578
- "Name of the probe"
1579
- name: String
1580
- "Severity of the probe (LOW to CRITICAL)"
1581
- severity: GqlProbeSeverity
1582
- "Status reported by the probe (GREEN to RED)"
1583
- status: GqlProbeStatus
1584
- }
1585
-
1586
- "Probe status"
1587
- type GqlProbeStatus {
1588
- "Health of the probe"
1589
- health: GqlProbeHealth
1590
- "Message explaining probe status"
1591
- message: String @deprecated(reason: "When multiple probe return the same error status (YELLOW or RED), the message does not guarantee which of the probe will get its message returned. We recommend using the \"health\" parameter and corresponding individual probe message instead.")
1592
- }
1593
-
1594
- "Publication background job"
1595
- type GqlPublicationBackgroundJob {
1596
- "The amount of time the job ran for (in milliseconds). The returned value will be -1 until the job has actually completed"
1597
- duration: Long
1598
- "The job group name"
1599
- group: String
1600
- "The job (Boolean) property that correspond to the given name. The returned value will be null in case the job doesn't have the property"
1601
- jobBooleanProperty(
1602
- "The name of the property"
1603
- name: String
1604
- ): Boolean
1605
- "Job description"
1606
- jobDescription: String
1607
- "The job (Int) property that correspond to the given name. The returned value will be null in case the job doesn't have the property"
1608
- jobIntegerProperty(
1609
- "The name of the property"
1610
- name: String
1611
- ): Int
1612
- "The job (Long) property that correspond to the given name. The returned value will be null in case the job doesn't have the property"
1613
- jobLongProperty(
1614
- "The name of the property"
1615
- name: String
1616
- ): Long
1617
- "The job state is different from the status, it reflect the last action done on the job instance (Started, Vetoed, Finished)"
1618
- jobState: GqlBackgroundJobState
1619
- "The job status"
1620
- jobStatus: GqlBackgroundJobStatus
1621
- "List of strings property from the job map (eg. publicationInfos, publicationPaths)"
1622
- jobStringListProperty(
1623
- "The name of the property"
1624
- name: String
1625
- ): [String]
1626
- "The job (String) property that correspond to the given name. The returned value will be null in case the job doesn't have the property"
1627
- jobStringProperty(
1628
- "The name of the property"
1629
- name: String
1630
- ): String
1631
- "Publication language"
1632
- language: String
1633
- "The name of the property"
1634
- name: String
1635
- "The site key. The returned value will be null in case the job doesn't have associated site key"
1636
- siteKey: String
1637
- "The user key. The returned value will be null in case the job doesn't have associated user key"
1638
- userKey: String
1639
- }
1640
-
1641
- "Publication event"
1642
- type GqlPublicationEvent {
1643
- "Language"
1644
- language: String
1645
- "Paths"
1646
- paths: [String]
1647
- "Site key"
1648
- siteKey: String
1649
- "State of the publication event"
1650
- state: State
1651
- "User"
1652
- user: String
1653
- }
1654
-
1655
- "Publication status information for a JCR node"
1656
- type GqlPublicationInfo {
1657
- "Whether current user is allowed to publish the node omitting any workflows"
1658
- allowedToPublishWithoutWorkflow: Boolean
1659
- "Whether node exists in live workspace"
1660
- existsInLive: Boolean
1661
- "Aggregated locked status of the node"
1662
- locked: Boolean
1663
- "Aggregated publication status of the node"
1664
- publicationStatus: PublicationStatus!
1665
- "Aggregated work-in-progress status of the node"
1666
- workInProgress: Boolean
1667
- }
1668
-
1669
- "Scheduler object which allows to access to background jobs"
1670
- type GqlScheduler {
1671
- "List of active jobs (deprecated)"
1672
- jobs: [GqlBackgroundJob] @deprecated(reason: "Use paginatedJobs instead")
1673
- "List of active jobs (paginated)"
1674
- paginatedJobs(
1675
- "fetching only nodes after this node (exclusive)"
1676
- after: String,
1677
- "fetching only nodes before this node (exclusive)"
1678
- before: String,
1679
- "Exclude jobs with these statuses"
1680
- excludeStatuses: [GqlBackgroundJobStatus],
1681
- "fetching only the first certain number of nodes"
1682
- first: Int,
1683
- "The group jobs belong to"
1684
- group: String,
1685
- "Include jobs with these statuses"
1686
- includeStatuses: [GqlBackgroundJobStatus],
1687
- "fetching only the last certain number of nodes"
1688
- last: Int,
1689
- "fetching only the first certain number of nodes"
1690
- limit: Int,
1691
- "fetching only nodes after this node (inclusive)"
1692
- offset: Int
1693
- ): GqlBackgroundJobConnection
1694
- }
1695
-
1696
- "API Scope"
1697
- type GqlScope {
1698
- "The description of the scope"
1699
- description: String
1700
- "The name of the scope"
1701
- name: String
1702
- }
1703
-
1704
- "Variant information for a given channel"
1705
- type GqlVariant {
1706
- "Variant display name/label (not localized)"
1707
- displayName: String
1708
- "Variant dimension (width x height) if available"
1709
- imageSize: GqlVariantDimension
1710
- "Variant name/identifier"
1711
- name: String
1712
- }
1713
-
1714
- "Represents dimensions (width, height) of a variant"
1715
- type GqlVariantDimension {
1716
- "Variant height"
1717
- height: String
1718
- "Variant width"
1719
- width: String
1720
- }
1721
-
1722
- type GqlWorkflowEvent {
1723
- "Number of tasks for current user"
1724
- activeWorkflowTaskCountForUser: Int
1725
- "Task that has just been created"
1726
- createdTask: Task
1727
- "Task that has just been ended"
1728
- endedTask: Task
1729
- "Workflow that has just been ended"
1730
- endedWorkflow: Workflow
1731
- "Workflow that has just been started"
1732
- startedWorkflow: Workflow
1733
- }
1734
-
1735
- "GraphQL representation of a Jahia group"
1736
- type Group implements Principal {
1737
- "Full display name"
1738
- displayName: String
1739
- "List of groups this principal belongs to"
1740
- groupMembership(
1741
- "fetching only nodes after this node (exclusive)"
1742
- after: String,
1743
- "fetching only nodes before this node (exclusive)"
1744
- before: String,
1745
- "Filter by graphQL fields values"
1746
- fieldFilter: InputFieldFiltersInput,
1747
- "Group fields according to specified criteria"
1748
- fieldGrouping: InputFieldGroupingInput,
1749
- "Sort by graphQL fields values"
1750
- fieldSorter: InputFieldSorterInput,
1751
- "fetching only the first certain number of nodes"
1752
- first: Int,
1753
- "fetching only the last certain number of nodes"
1754
- last: Int,
1755
- "fetching only the first certain number of nodes"
1756
- limit: Int,
1757
- "fetching only nodes after this node (inclusive)"
1758
- offset: Int,
1759
- "Return only groups which belong to this site"
1760
- site: String
1761
- ): GroupConnection!
1762
- "Is this principal member of the specified group"
1763
- memberOf(
1764
- "Target group"
1765
- group: String,
1766
- "Site where the group is defined"
1767
- site: String
1768
- ): Boolean
1769
- "Group members"
1770
- members(
1771
- "fetching only nodes after this node (exclusive)"
1772
- after: String,
1773
- "fetching only nodes before this node (exclusive)"
1774
- before: String,
1775
- "Filter by graphQL fields values"
1776
- fieldFilter: InputFieldFiltersInput,
1777
- "Group fields according to specified criteria"
1778
- fieldGrouping: InputFieldGroupingInput,
1779
- "Sort by graphQL fields values"
1780
- fieldSorter: InputFieldSorterInput,
1781
- "fetching only the first certain number of nodes"
1782
- first: Int,
1783
- "fetching only the last certain number of nodes"
1784
- last: Int,
1785
- "fetching only the first certain number of nodes"
1786
- limit: Int,
1787
- "fetching only nodes after this node (inclusive)"
1788
- offset: Int
1789
- ): PrincipalConnection!
1790
- "Group name"
1791
- name: String!
1792
- "Get the corresponding JCR node"
1793
- node: JCRNode
1794
- "Return GROUP principal type"
1795
- principalType: PrincipalType
1796
- "Group property"
1797
- property(
1798
- "The name of the property"
1799
- name: String!
1800
- ): String
1801
- "Site where the group is defined"
1802
- site: JCRSite
1803
- }
1804
-
1805
- "A connection to a list of items."
1806
- type GroupConnection {
1807
- "a list of edges"
1808
- edges: [GroupEdge]
1809
- "a list of nodes"
1810
- nodes: [Group]
1811
- "details about this specific page"
1812
- pageInfo: PageInfo!
1813
- }
1814
-
1815
- "An edge in a connection"
1816
- type GroupEdge {
1817
- "cursor marks a unique position or index into the connection"
1818
- cursor: String!
1819
- "index in the connection"
1820
- index: Int
1821
- "The item at the end of the edge"
1822
- node: Group
1823
- }
1824
-
1825
- "Asset type for image"
1826
- type ImageAsset {
1827
- "Image height"
1828
- height: Float
1829
- "Asset metadata"
1830
- metadata: Metadata
1831
- "Image size"
1832
- size: Float
1833
- "Mime type of image"
1834
- type: String
1835
- "Image width"
1836
- width: Float
1837
- }
1838
-
1839
- "JCR Mutations"
1840
- type JCRMutation {
1841
- "Creates a new JCR node under the specified parent"
1842
- addNode(
1843
- children: [InputJCRNode],
1844
- "The collection of mixin type names"
1845
- mixins: [String],
1846
- "The name of the node to create"
1847
- name: String!,
1848
- "The path or id of the parent node"
1849
- parentPathOrId: String!,
1850
- "The primary node type of the node to create"
1851
- primaryNodeType: String!,
1852
- properties: [InputJCRProperty],
1853
- "If true, use the next available name for a node, appending if needed numbers. Default is false"
1854
- useAvailableNodeName: Boolean
1855
- ): JCRNodeMutation
1856
- "Batch creates a number of new JCR nodes under the specified parent"
1857
- addNodesBatch(
1858
- "The collection of nodes to create"
1859
- nodes: [InputJCRNodeWithParent]!
1860
- ): [JCRNodeMutation]
1861
- "Copy a single node to a different parent node"
1862
- copyNode(
1863
- "The child node types that should be skipped during copy"
1864
- childNodeTypesToSkip: [String],
1865
- "The name of the node at the new location or null if its current name should be preserved"
1866
- destName: String,
1867
- "Path or UUID of the destination parent node to copy the node to"
1868
- destParentPathOrId: String!,
1869
- "Path or UUID of the node to be copied"
1870
- pathOrId: String!
1871
- ): JCRNodeMutation
1872
- "Copy multiple nodes to different parent node(s)"
1873
- copyNodes(
1874
- "The child node types that should be skipped during copy"
1875
- childNodeTypesToSkip: [String],
1876
- nodes: [InputCarriedJCRNode!]!
1877
- ): [JCRNodeMutation]
1878
- "Delete an existing node and all its children"
1879
- deleteNode(
1880
- "The path or id of the node to delete"
1881
- pathOrId: String!
1882
- ): Boolean
1883
- "Import a file under the specified parent"
1884
- importContent(
1885
- "Name of the request part that contains desired import file body"
1886
- file: String!,
1887
- "The path or id of the parent node"
1888
- parentPathOrId: String!,
1889
- "Specify the behaviour in case of existing content, possible values are in the DocumentViewImportHandler class"
1890
- rootBehaviour: Int = 2
1891
- ): Boolean
1892
- "Marks the existing node and all its children for deletion"
1893
- markNodeForDeletion(
1894
- "Optional deletion comment"
1895
- comment: String,
1896
- "The path or id of the node to mark for deletion"
1897
- pathOrId: String!
1898
- ): Boolean
1899
- "Get a collection of nodes that were modified by current GraphQL request"
1900
- modifiedNodes: [JCRNode]
1901
- "Move a single node to a different parent node"
1902
- moveNode(
1903
- "The name of the node at the new location or null if its current name should be preserved"
1904
- destName: String,
1905
- "Path or UUID of the destination parent node to move the node to"
1906
- destParentPathOrId: String!,
1907
- "Path or UUID of the node to be moved"
1908
- pathOrId: String!
1909
- ): JCRNodeMutation
1910
- "Move multiple nodes to different parent node(s)"
1911
- moveNodes(nodes: [InputCarriedJCRNode!]!): [JCRNodeMutation]
1912
- "Mutates an existing node, based on path or id"
1913
- mutateNode(
1914
- "The path or id of the node to mutate"
1915
- pathOrId: String!
1916
- ): JCRNodeMutation
1917
- "Mutates a set of existing nodes, based on path or id"
1918
- mutateNodes(
1919
- "The paths or id ofs the nodes to mutate"
1920
- pathsOrIds: [String]!
1921
- ): [JCRNodeMutation]
1922
- "Mutates a set of existing nodes, based on query execution"
1923
- mutateNodesByQuery(
1924
- "The maximum size of the result set"
1925
- limit: Long,
1926
- "The start offset of the result set"
1927
- offset: Long,
1928
- "The query string"
1929
- query: String!,
1930
- "The query language"
1931
- queryLanguage: QueryLanguage = SQL2
1932
- ): [JCRNodeMutation]
1933
- "Vanity URL Mutation"
1934
- mutateVanityUrls(
1935
- "Paths or UUIDs of vanity URL nodes to mutate"
1936
- pathsOrIds: [String]!
1937
- ): [VanityUrlMappingMutation]
1938
- "Paste a single node to a different parent node"
1939
- pasteNode(
1940
- "The child node types that should be skipped during copy"
1941
- childNodeTypesToSkip: [String],
1942
- "The name of the node at the new location or null if its current name should be preserved"
1943
- destName: String,
1944
- "Path or UUID of the destination parent node to paste the node to"
1945
- destParentPathOrId: String!,
1946
- "Paste mode, either COPY or MOVE"
1947
- mode: PasteMode!,
1948
- "The way to deal with duplicate node names when they are not allowed, either FAIL or RENAME"
1949
- namingConflictResolution: NodeNamingConflictResolutionStrategy = FAIL,
1950
- "Path or UUID of the node to be pasted"
1951
- pathOrId: String!
1952
- ): JCRNodeMutation
1953
- "Paste multiple nodes to different parent node(s)"
1954
- pasteNodes(
1955
- "The child node types that should be skipped during copy"
1956
- childNodeTypesToSkip: [String],
1957
- "Paste mode, either COPY or MOVE"
1958
- mode: PasteMode!,
1959
- "The way to deal with duplicate node names when they are not allowed, either FAIL or RENAME"
1960
- namingConflictResolution: NodeNamingConflictResolutionStrategy = FAIL,
1961
- "Info about nodes to paste and their new parent node(s)"
1962
- nodes: [InputCarriedJCRNode!]!
1963
- ): [JCRNodeMutation]
1964
- "Unmarks the specified node and all its children for deletion"
1965
- unmarkNodeForDeletion(
1966
- "The path or id of the node to unmark for deletion"
1967
- pathOrId: String!
1968
- ): Boolean
1969
- }
1970
-
1971
- "Aggregations on JCR Nodes"
1972
- type JCRNodeAggregation {
1973
- "Average aggregation"
1974
- avg: StatAggregation
1975
- "Count aggregation"
1976
- count: CountAggregation
1977
- "Max aggregation"
1978
- max: StatAggregation
1979
- "Min aggregation"
1980
- min: StatAggregation
1981
- "Sum aggregation"
1982
- sum: StatAggregation
1983
- }
1984
-
1985
- "A connection to a list of items."
1986
- type JCRNodeConnection {
1987
- "Get an aggregation by fields on nodes of this connection"
1988
- aggregation: JCRNodeAggregation
1989
- "a list of edges"
1990
- edges: [JCRNodeEdge]
1991
- "a list of nodes"
1992
- nodes: [JCRNode]
1993
- "details about this specific page"
1994
- pageInfo: PageInfo!
1995
- }
1996
-
1997
- "GraphQL representation of a JCR node definition"
1998
- type JCRNodeDefinition implements JCRItemDefinition {
1999
- "Reports whether this child node can have same-name siblings. In other words, whether the parent node can have more than one child node of this name."
2000
- allowsSameNameSiblings: Boolean!
2001
- "Reports whether the item is to be automatically created when its parent node is created."
2002
- autoCreated: Boolean!
2003
- "Gets the node type that contains the declaration of this definition."
2004
- declaringNodeType: JCRNodeType!
2005
- "Gets the default primary node type that will be assigned to the child node if it is created without an explicitly specified primary node type."
2006
- defaultPrimaryType: JCRNodeType
2007
- "Reports whether the child item is hidden from UI."
2008
- hidden: Boolean!
2009
- "Reports whether the item is mandatory. A mandatory item is one that, if its parent node exists, must also exist."
2010
- mandatory: Boolean!
2011
- "Gets the name of the child item."
2012
- name: String!
2013
- "Reports whether the child item is protected."
2014
- protected: Boolean!
2015
- "Gets the minimum set of primary node types that the child node must have."
2016
- requiredPrimaryType: [JCRNodeType]
2017
- }
2018
-
2019
- "An edge in a connection"
2020
- type JCRNodeEdge {
2021
- "cursor marks a unique position or index into the connection"
2022
- cursor: String!
2023
- "index in the connection"
2024
- index: Int
2025
- "The item at the end of the edge"
2026
- node: JCRNode
2027
- }
2028
-
2029
- "Mutations on a JCR node"
2030
- type JCRNodeMutation {
2031
- "Creates a new JCR node under the current node"
2032
- addChild(
2033
- children: [InputJCRNode],
2034
- "The collection of mixin type names"
2035
- mixins: [String],
2036
- "The name of the node to create"
2037
- name: String!,
2038
- "The primary node type of the node to create"
2039
- primaryNodeType: String!,
2040
- properties: [InputJCRProperty],
2041
- "If true, use the next available name for a node, appending if needed numbers. Default is false"
2042
- useAvailableNodeName: Boolean
2043
- ): JCRNodeMutation
2044
- "Batch creates a number of new JCR nodes under the current node"
2045
- addChildrenBatch(
2046
- "The collection of nodes to create"
2047
- nodes: [InputJCRNode]!
2048
- ): [JCRNodeMutation]
2049
- "Adds mixin types on the current node"
2050
- addMixins(
2051
- "The collection of mixin type names"
2052
- mixins: [String]!
2053
- ): [String]
2054
- "Add vanity URL"
2055
- addVanityUrl(
2056
- "The list of vanity url to create"
2057
- vanityUrlInputList: [InputVanityUrl]!
2058
- ): [VanityUrlMappingMutation]
2059
- "Unlock all nodes under the specified node"
2060
- clearAllLocks: Boolean
2061
- "Create new version for the node if the node supports versioning"
2062
- createVersion: Boolean
2063
- "Add wip information"
2064
- createWipInfo(
2065
- "Work in progress information to save"
2066
- wipInfo: InputwipInfo!
2067
- ): Boolean
2068
- "Delete the current node (and its subgraph)"
2069
- delete: Boolean
2070
- "Grant role permissions to specified principal user/group for the given node"
2071
- grantRoles(
2072
- "Name of principal (user/group)"
2073
- principalName: String!,
2074
- "Type of principal (user/group) specified"
2075
- principalType: PrincipalType!,
2076
- "Roles to grant user/group for this node"
2077
- roleNames: [String]!
2078
- ): Boolean
2079
- "Import a file under the current node"
2080
- importContent(
2081
- "Name of the request part that contains desired import file body"
2082
- file: String!
2083
- ): Boolean
2084
- "Lock the node"
2085
- lock(
2086
- "Type of lock, defaults to user"
2087
- type: String = "user"
2088
- ): Boolean
2089
- "Mark the current node (and its subgraph) for deletion"
2090
- markForDeletion(
2091
- "Optional deletion comment"
2092
- comment: String
2093
- ): Boolean
2094
- "Moves the current node to a specified destination path (if destPath is specified) or moves it under the specified node (if parentPathOrId is specified). Either of two parameters is expected."
2095
- move(
2096
- "The target node path of the current node after the move operation"
2097
- destPath: String,
2098
- "The parent node path or id under which the current node will be moved to"
2099
- parentPathOrId: String,
2100
- "Renames current node before moving if the name exists under destination node"
2101
- renameOnConflict: Boolean
2102
- ): String
2103
- "Mutates a set of existing direct sub nodes, based on filters passed as parameter"
2104
- mutateChildren(
2105
- "Filter of child nodes by their names; null to avoid such filtering"
2106
- names: [String],
2107
- "Filter of child nodes by their property values; null to avoid such filtering"
2108
- propertiesFilter: InputNodePropertiesInput,
2109
- "Filter of child nodes by their types; null to avoid such filtering"
2110
- typesFilter: InputNodeTypesInput
2111
- ): [JCRNodeMutation]
2112
- "Mutates an existing sub node, based on its relative path to the current node"
2113
- mutateDescendant(
2114
- "Name or relative path of the sub node to mutate"
2115
- relPath: String!
2116
- ): JCRNodeMutation
2117
- "Mutates a set of existing descendant nodes, based on filters passed as parameter"
2118
- mutateDescendants(
2119
- "Filter of descendant nodes by their property values; null to avoid such filtering"
2120
- propertiesFilter: InputNodePropertiesInput,
2121
- "Filter out and stop recursion on nodes by their property values; null to avoid such filtering"
2122
- recursionPropertiesFilter: InputNodePropertiesInput,
2123
- "Filter out and stop recursion on nodes by their types; null to avoid such filtering"
2124
- recursionTypesFilter: InputNodeTypesInput,
2125
- "Filter of descendant nodes by their types; null to avoid such filtering"
2126
- typesFilter: InputNodeTypesInput
2127
- ): [JCRNodeMutation]
2128
- "Mutates or creates a set of properties on the current node"
2129
- mutateProperties(
2130
- "The names of the JCR properties; null to obtain all properties"
2131
- names: [String]
2132
- ): [JCRPropertyMutation]
2133
- "Mutates or creates a property on the current node"
2134
- mutateProperty(
2135
- "The name of the property to update"
2136
- name: String!
2137
- ): JCRPropertyMutation
2138
- "Update a vanity URL"
2139
- mutateVanityUrl(
2140
- "The url to edit"
2141
- url: String!
2142
- ): VanityUrlMappingMutation
2143
- "Update vanity URLs"
2144
- mutateVanityUrls(
2145
- "Filter by languages"
2146
- languages: [String]
2147
- ): [VanityUrlMappingMutation]
2148
- "Mutate wip information"
2149
- mutateWipInfo(
2150
- "Work in progress information to save"
2151
- wipInfo: InputwipInfo!
2152
- ): Boolean
2153
- "Get the graphQL representation of the node currently being mutated"
2154
- node: JCRNode
2155
- "Publish the node in certain languages"
2156
- publish(
2157
- "Publish all sub tree including sub pages. Default is false."
2158
- includeSubTree: Boolean = false,
2159
- "Languages to publish the node in"
2160
- languages: [String],
2161
- "Publish all sub and related nodes. Default is true."
2162
- publishSubNodes: Boolean = true
2163
- ): Boolean
2164
- "Removes mixin types on the current node"
2165
- removeMixins(
2166
- "The collection of mixin type names"
2167
- mixins: [String]!
2168
- ): [String]
2169
- "Rename the current node"
2170
- rename(
2171
- "The new name of the node"
2172
- name: String!
2173
- ): String
2174
- "Reorder child nodes according to the list of names passed"
2175
- reorderChildren(
2176
- "List of child node names in the desired order"
2177
- names: [String]!,
2178
- "The target position of reordered child nodes. The default value is inplace."
2179
- position: ReorderedChildrenPosition = INPLACE
2180
- ): Boolean
2181
- "Remove/deny roles to specified principal user/group for the given node"
2182
- revokeRoles(
2183
- "Name of principal (user/group)"
2184
- principalName: String!,
2185
- "Type of principal (user/group) specified"
2186
- principalType: PrincipalType!,
2187
- "Roles to grant user/group for this node"
2188
- roleNames: [String]!
2189
- ): Boolean
2190
- "Mutates or creates a set of properties on the current node"
2191
- setPropertiesBatch(
2192
- "The collection of JCR properties to set"
2193
- properties: [InputJCRProperty]
2194
- ): [JCRPropertyMutation]
2195
- startWorkflow(definition: String, language: String): Boolean
2196
- "Return image transformation mutation"
2197
- transformImage(
2198
- "name of target file, if different"
2199
- name: String,
2200
- "target path, if different"
2201
- targetPath: String
2202
- ): GqlJcrImageTransformMutation
2203
- "Unlock the node"
2204
- unlock(
2205
- "Type of lock, defaults to user"
2206
- type: String = "user"
2207
- ): Boolean
2208
- "Unmark this node and all the sub-nodes for deletion"
2209
- unmarkForDeletion: Boolean
2210
- "Unpublish the node in certain languages"
2211
- unpublish(
2212
- "Languages to publish the node in"
2213
- languages: [String]
2214
- ): Boolean
2215
- "Get the identifier of the node currently being mutated"
2216
- uuid: String
2217
- "Return zip mutation"
2218
- zip: ZipFileMutation
2219
- }
2220
-
2221
- "GraphQL representation of a JCR node type"
2222
- type JCRNodeType {
2223
- "Returns true if this is an abstract node type; returns false otherwise."
2224
- abstract: Boolean
2225
- "Node type displayable name"
2226
- displayName(
2227
- "Language"
2228
- language: String!
2229
- ): String
2230
- "Returns true if nodes of this type must support orderable child nodes; returns false otherwise."
2231
- hasOrderableChildNodes: Boolean
2232
- "Node type icon"
2233
- icon: String
2234
- "Reports if the current node type matches the nodetype(s) passed in parameter"
2235
- isNodeType(
2236
- "Node type name"
2237
- type: InputNodeTypesInput!
2238
- ): Boolean!
2239
- "Returns true if this is a mixin type; returns false otherwise."
2240
- mixin: Boolean
2241
- "Node type name"
2242
- name: String
2243
- "Returns an array containing the child node definitions of this node type."
2244
- nodes(
2245
- "Filter by graphQL fields values"
2246
- fieldFilter: InputFieldFiltersInput
2247
- ): [JCRNodeDefinition]
2248
- "Returns the name of the primary item (one of the child items of the nodes of this node type). If this node has no primary item, then this method null."
2249
- primaryItem: JCRItemDefinition
2250
- "Returns an array containing the property definitions of this node type."
2251
- properties(
2252
- "Filter by graphQL fields values"
2253
- fieldFilter: InputFieldFiltersInput
2254
- ): [JCRPropertyDefinition]
2255
- "Returns true if the node type is queryable."
2256
- queryable: Boolean
2257
- "Returns all subtypes of this node type in the node type inheritance hierarchy."
2258
- subTypes(
2259
- "fetching only nodes after this node (exclusive)"
2260
- after: String,
2261
- "fetching only nodes before this node (exclusive)"
2262
- before: String,
2263
- "fetching only the first certain number of nodes"
2264
- first: Int,
2265
- "fetching only the last certain number of nodes"
2266
- last: Int,
2267
- "fetching only the first certain number of nodes"
2268
- limit: Int,
2269
- "fetching only nodes after this node (inclusive)"
2270
- offset: Int
2271
- ): JCRNodeTypeConnection
2272
- "Returns all supertypes of this node type in the node type inheritance hierarchy."
2273
- supertypes(
2274
- "Filter by graphQL fields values"
2275
- fieldFilter: InputFieldFiltersInput
2276
- ): [JCRNodeType]
2277
- "System ID of the node type, corresponding to the name of the module declaring it."
2278
- systemId: String
2279
- }
2280
-
2281
- "A connection to a list of items."
2282
- type JCRNodeTypeConnection {
2283
- "a list of edges"
2284
- edges: [JCRNodeTypeEdge]
2285
- "a list of nodes"
2286
- nodes: [JCRNodeType]
2287
- "details about this specific page"
2288
- pageInfo: PageInfo!
2289
- }
2290
-
2291
- "An edge in a connection"
2292
- type JCRNodeTypeEdge {
2293
- "cursor marks a unique position or index into the connection"
2294
- cursor: String!
2295
- "index in the connection"
2296
- index: Int
2297
- "The item at the end of the edge"
2298
- node: JCRNodeType
2299
- }
2300
-
2301
- "GraphQL representation of a JCR property."
2302
- type JCRProperty {
2303
- "The value of the JCR property as a Boolean in case the property is single-valued, null otherwise"
2304
- booleanValue: Boolean
2305
- "The values of the JCR property as Booleans in case the property is multiple-valued, null otherwise"
2306
- booleanValues: [Boolean]
2307
- "The value of the JCR property rendered by the specified choicelist renderer in case the property is single-valued, null otherwise"
2308
- choicelistValue(
2309
- "The language"
2310
- language: String,
2311
- "The choicelist renderer name to be used"
2312
- renderer: String
2313
- ): String
2314
- "The value of the JCR property rendered by the specified choicelist renderer in case the property is multiple-valued, null otherwise"
2315
- choicelistValues(
2316
- "The language"
2317
- language: String,
2318
- "The choicelist renderer name to be used"
2319
- renderer: String
2320
- ): [String]
2321
- "The decrypted value of the JCR encrypted property as a String in case the property is single-valued, null otherwise"
2322
- decryptedValue: String
2323
- "The decrypted values of the JCR encrypted property as a Strings in case the property is multiple-valued, null otherwise"
2324
- decryptedValues: [String]
2325
- "Returns the property definition that applies to this property."
2326
- definition: JCRPropertyDefinition
2327
- "The value of the JCR property as a Float in case the property is single-valued, null otherwise"
2328
- floatValue: Float
2329
- "The values of the JCR property as Floats in case the property is multiple-valued, null otherwise"
2330
- floatValues: [Float]
2331
- "Whether the property is internationalized"
2332
- internationalized: Boolean!
2333
- "The language the property value was obtained in for internationalized properties; null for non-internationalized ones"
2334
- language: String
2335
- "The value of the JCR property as a Long in case the property is single-valued, null otherwise"
2336
- longValue: Long
2337
- "The values of the JCR property as Longs in case the property is multiple-valued, null otherwise"
2338
- longValues: [Long]
2339
- "The name of the JCR property"
2340
- name: String!
2341
- "The GraphQL representation of the JCR node the property belongs to."
2342
- node: JCRNode!
2343
- "The value of the JCR property casted as date and returned in this string format: [yyyy-MM-dd'T'HH:mm:ss.SSS] in case the property is single-valued, null otherwise"
2344
- notZonedDateValue: String
2345
- "The values of the JCR property casted as date and returned in this string format: [yyyy-MM-dd'T'HH:mm:ss.SSS] in case the property is multiple-valued, null otherwise"
2346
- notZonedDateValues: [String]
2347
- "The path of the JCR property"
2348
- path: String!
2349
- "GraphQL representation of the node this property references in case the property is single-valued, null otherwise"
2350
- refNode: JCRNode
2351
- "GraphQL representations of the nodes this property references in case the property is multiple-valued, null otherwise"
2352
- refNodes: [JCRNode]
2353
- "Gets the rendered value of that property"
2354
- renderedValue: String
2355
- "Gets the rendered values of that property"
2356
- renderedValues: [String]
2357
- "The binary size of the JCR node as a Long, null otherwise"
2358
- size: Long
2359
- "The type of the JCR property"
2360
- type: JCRPropertyType!
2361
- "The value of the JCR property as a String in case the property is single-valued, null otherwise"
2362
- value: String
2363
- "The values of the JCR property as Strings in case the property is multiple-valued, null otherwise"
2364
- values: [String]
2365
- }
2366
-
2367
- "A connection to a list of items."
2368
- type JCRPropertyConnection {
2369
- "a list of edges"
2370
- edges: [JCRPropertyEdge]
2371
- "a list of nodes"
2372
- nodes: [JCRProperty]
2373
- "details about this specific page"
2374
- pageInfo: PageInfo!
2375
- }
2376
-
2377
- "GraphQL representation of a JCR property definition"
2378
- type JCRPropertyDefinition implements JCRItemDefinition {
2379
- "Reports whether the item is to be automatically created when its parent node is created."
2380
- autoCreated: Boolean!
2381
- "Property constraints"
2382
- constraints: [String]!
2383
- "Gets the node type that contains the declaration of this definition."
2384
- declaringNodeType: JCRNodeType!
2385
- "Gets the displayable name of the property for the given language code. Return the system name in case the label doesn't exists"
2386
- displayName(
2387
- "Language"
2388
- language: String!
2389
- ): String!
2390
- "Reports whether the child item is hidden from UI."
2391
- hidden: Boolean!
2392
- "Reports whether this property has language dependant values."
2393
- internationalized: Boolean!
2394
- "Reports whether the item is mandatory. A mandatory item is one that, if its parent node exists, must also exist."
2395
- mandatory: Boolean!
2396
- "Reports whether this property can have multiple values."
2397
- multiple: Boolean!
2398
- "Gets the name of the child item."
2399
- name: String!
2400
- "Reports whether the child item is protected."
2401
- protected: Boolean!
2402
- "Gets the required type of the property."
2403
- requiredType: JCRPropertyType!
2404
- }
2405
-
2406
- "An edge in a connection"
2407
- type JCRPropertyEdge {
2408
- "cursor marks a unique position or index into the connection"
2409
- cursor: String!
2410
- "index in the connection"
2411
- index: Int
2412
- "The item at the end of the edge"
2413
- node: JCRProperty
2414
- }
2415
-
2416
- "Mutations on a JCR property"
2417
- type JCRPropertyMutation {
2418
- "Add a new value to this property"
2419
- addValue(language: String, option: JCRPropertyOption, type: JCRPropertyType, value: String): Boolean
2420
- "Add new values to this property"
2421
- addValues(language: String, option: JCRPropertyOption, type: JCRPropertyType, values: [String]): Boolean
2422
- "Delete this property"
2423
- delete(language: String): Boolean
2424
- "Get the path of the property currently being mutated"
2425
- path: String
2426
- "Get the graphQL representation of the property currently being mutated"
2427
- property: JCRProperty
2428
- "Remove a new value from this property"
2429
- removeValue(language: String, option: JCRPropertyOption, type: JCRPropertyType, value: String): Boolean
2430
- "Remove values from this property"
2431
- removeValues(language: String, option: JCRPropertyOption, type: JCRPropertyType, values: [String]): Boolean
2432
- "Set property value"
2433
- setValue(language: String, option: JCRPropertyOption, type: JCRPropertyType, value: String): Boolean
2434
- "Set property values"
2435
- setValues(language: String, option: JCRPropertyOption, type: JCRPropertyType, values: [String]): Boolean
2436
- }
2437
-
2438
- "JCR Queries"
2439
- type JCRQuery {
2440
- "Retrieves the number of active workflow tasks for the current user"
2441
- activeWorkflowTaskCountForUser: Int @deprecated(reason: "Use /workflow/activeWorkflowTaskCountForUser instead")
2442
- "Get GraphQL representation of a node by its UUID"
2443
- nodeById(
2444
- "The UUID of the node"
2445
- uuid: String!,
2446
- """
2447
-
2448
- Check node validity in this language.
2449
-
2450
- Node validity is determined by multiple conditions:
2451
-
2452
- * The node exists
2453
- * The node is not attached to a visibility condition preventing its display
2454
- * The node is published in this language
2455
- * The node's language has not been invalidated.
2456
- """
2457
- validInLanguage: String
2458
- ): JCRNode
2459
- "Get GraphQL representation of a node by its path"
2460
- nodeByPath(
2461
- "The path of the node"
2462
- path: String!,
2463
- """
2464
-
2465
- Check node validity in this language.
2466
-
2467
- Node validity is determined by multiple conditions:
2468
-
2469
- * The node exists
2470
- * The node is not attached to a visibility condition preventing its display
2471
- * The node is published in this language
2472
- * The node's language has not been invalidated.
2473
- """
2474
- validInLanguage: String
2475
- ): JCRNode
2476
- "Get a node type by its name"
2477
- nodeTypeByName(
2478
- "Node type name"
2479
- name: String!
2480
- ): JCRNodeType
2481
- "Get a list of nodetypes based on specified parameter"
2482
- nodeTypes(
2483
- "fetching only nodes after this node (exclusive)"
2484
- after: String,
2485
- "fetching only nodes before this node (exclusive)"
2486
- before: String,
2487
- "Filter by graphQL fields values"
2488
- fieldFilter: InputFieldFiltersInput,
2489
- "Filter on node type"
2490
- filter: InputNodeTypesListInput,
2491
- "fetching only the first certain number of nodes"
2492
- first: Int,
2493
- "fetching only the last certain number of nodes"
2494
- last: Int,
2495
- "fetching only the first certain number of nodes"
2496
- limit: Int,
2497
- "fetching only nodes after this node (inclusive)"
2498
- offset: Int
2499
- ): JCRNodeTypeConnection
2500
- "Get multiple node types by their names"
2501
- nodeTypesByNames(
2502
- "Node type names"
2503
- names: [String]!
2504
- ): [JCRNodeType]
2505
- "handles query nodes with QOM factory"
2506
- nodesByCriteria(
2507
- "fetching only nodes after this node (exclusive)"
2508
- after: String,
2509
- "fetching only nodes before this node (exclusive)"
2510
- before: String,
2511
- "The criteria to fetch nodes by"
2512
- criteria: InputGqlJcrNodeCriteriaInput!,
2513
- "Filter by GraphQL field values"
2514
- fieldFilter: InputFieldFiltersInput,
2515
- "Group fields by criteria"
2516
- fieldGrouping: InputFieldGroupingInput,
2517
- "sort by GraphQL field values"
2518
- fieldSorter: InputFieldSorterInput,
2519
- "fetching only the first certain number of nodes"
2520
- first: Int,
2521
- "fetching only the last certain number of nodes"
2522
- last: Int,
2523
- "fetching only the first certain number of nodes"
2524
- limit: Int,
2525
- "fetching only nodes after this node (inclusive)"
2526
- offset: Int
2527
- ): JCRNodeConnection
2528
- "Get GraphQL representations of multiple nodes by their UUIDs"
2529
- nodesById(
2530
- "The UUIDs of the nodes"
2531
- uuids: [String!]!,
2532
- """
2533
-
2534
- Check node validity in this language.
2535
-
2536
- Node validity is determined by multiple conditions:
2537
-
2538
- * The node exists
2539
- * The node is not attached to a visibility condition preventing its display
2540
- * The node is published in this language
2541
- * The node's language has not been invalidated.
2542
- """
2543
- validInLanguage: String
2544
- ): [JCRNode]!
2545
- "Get GraphQL representations of multiple nodes by their paths"
2546
- nodesByPath(
2547
- "The paths of the nodes"
2548
- paths: [String!]!,
2549
- """
2550
-
2551
- Check node validity in this language.
2552
-
2553
- Node validity is determined by multiple conditions:
2554
-
2555
- * The node exists
2556
- * The node is not attached to a visibility condition preventing its display
2557
- * The node is published in this language
2558
- * The node's language has not been invalidated.
2559
- """
2560
- validInLanguage: String
2561
- ): [JCRNode]!
2562
- "Get GraphQL representations of nodes using a query language supported by JCR"
2563
- nodesByQuery(
2564
- "fetching only nodes after this node (exclusive)"
2565
- after: String,
2566
- "fetching only nodes before this node (exclusive)"
2567
- before: String,
2568
- "Filter by graphQL fields values"
2569
- fieldFilter: InputFieldFiltersInput,
2570
- "Group fields by criteria"
2571
- fieldGrouping: InputFieldGroupingInput,
2572
- "Sort by GraphQL field values"
2573
- fieldSorter: InputFieldSorterInput,
2574
- "fetching only the first certain number of nodes"
2575
- first: Int,
2576
- "Language to use for the query"
2577
- language: String,
2578
- "fetching only the last certain number of nodes"
2579
- last: Int,
2580
- "fetching only the first certain number of nodes"
2581
- limit: Int,
2582
- "fetching only nodes after this node (inclusive)"
2583
- offset: Int,
2584
- "The query string"
2585
- query: String!,
2586
- "The query language"
2587
- queryLanguage: QueryLanguage = SQL2
2588
- ): JCRNodeConnection
2589
- "Get the workspace of the query"
2590
- workspace: Workspace!
2591
- }
2592
-
2593
- "GraphQL representation of a site node"
2594
- type JCRSite implements JCRNode {
2595
- "Get ACL info for this node"
2596
- acl: GqlAcl
2597
- "Get the last modified date of this node and its descendants. The recursion in descendants can be controlled by recursionTypesFilter. If no filter is passed, recursion will stop by default on sub pages."
2598
- aggregatedLastModifiedDate(
2599
- "The language"
2600
- language: String,
2601
- "Stop recursion on graphql field values"
2602
- recursionTypesFilter: InputNodeTypesInput
2603
- ): String
2604
- "Aggregated publication info about the JCR node"
2605
- aggregatedPublicationInfo(
2606
- "Publication language"
2607
- language: String!,
2608
- "Whether to take references into account when calculating the aggregated publication status"
2609
- references: Boolean = false,
2610
- "Whether to take sub-nodes into account when calculating the aggregated publication status"
2611
- subNodes: Boolean = false
2612
- ): GqlPublicationInfo!
2613
- "Render URL in ajax mode"
2614
- ajaxRenderUrl: String
2615
- "Returns a list of types allowed under the provided node"
2616
- allowedChildNodeTypes(
2617
- "Filter by GraphQL fields values"
2618
- fieldFilter: InputFieldFiltersInput,
2619
- "Whether all sub-types of allowed child node types should be included"
2620
- includeSubTypes: Boolean = true
2621
- ): [JCRNodeType]
2622
- "GraphQL representations of the ancestor nodes of the JCR node, top down direction"
2623
- ancestors(
2624
- "Filter by graphQL fields values"
2625
- fieldFilter: InputFieldFiltersInput,
2626
- "The path of the topmost ancestor node to include in the result; null or empty string to include all the ancestor nodes"
2627
- upToPath: String
2628
- ): [JCRNode]!
2629
- "GraphQL representations of the child nodes, according to parameters passed"
2630
- children(
2631
- "fetching only nodes after this node (exclusive)"
2632
- after: String,
2633
- "fetching only nodes before this node (exclusive)"
2634
- before: String,
2635
- "Filter by graphQL fields values"
2636
- fieldFilter: InputFieldFiltersInput,
2637
- "Group fields according to specified criteria"
2638
- fieldGrouping: InputFieldGroupingInput,
2639
- "Sort by graphQL fields values"
2640
- fieldSorter: InputFieldSorterInput,
2641
- "fetching only the first certain number of nodes"
2642
- first: Int,
2643
- "Include the current node itself in results"
2644
- includesSelf: Boolean = false,
2645
- "fetching only the last certain number of nodes"
2646
- last: Int,
2647
- "fetching only the first certain number of nodes"
2648
- limit: Int,
2649
- "Filter of child nodes by their names; null to avoid such filtering"
2650
- names: [String],
2651
- "fetching only nodes after this node (inclusive)"
2652
- offset: Int,
2653
- "Filter of child nodes by their property values; null to avoid such filtering"
2654
- propertiesFilter: InputNodePropertiesInput,
2655
- "Filter of child nodes by their types; null to avoid such filtering"
2656
- typesFilter: InputNodeTypesInput,
2657
- "Language to use to get children"
2658
- validInLanguage: String
2659
- ): JCRNodeConnection
2660
- "Site default language"
2661
- defaultLanguage: String
2662
- "Read default Work in progress information. Set by \"wip.checkbox.checked\" system proprety"
2663
- defaultWipInfo: wipInfo
2664
- "Returns the node definition that applies to this node."
2665
- definition: JCRNodeDefinition
2666
- "The depth in the JCR Tree of the JCR node this object represents"
2667
- depth: Int!
2668
- "GraphQL representation of a descendant node, based on its relative path"
2669
- descendant(
2670
- "Name or relative path of the sub node"
2671
- relPath: String!
2672
- ): JCRNode
2673
- "GraphQL representations of the descendant nodes, according to parameters passed"
2674
- descendants(
2675
- "fetching only nodes after this node (exclusive)"
2676
- after: String,
2677
- "fetching only nodes before this node (exclusive)"
2678
- before: String,
2679
- "Filter by graphQL fields values"
2680
- fieldFilter: InputFieldFiltersInput,
2681
- "Group fields according to specified criteria"
2682
- fieldGrouping: InputFieldGroupingInput,
2683
- "Sort by graphQL fields values"
2684
- fieldSorter: InputFieldSorterInput,
2685
- "fetching only the first certain number of nodes"
2686
- first: Int,
2687
- "fetching only the last certain number of nodes"
2688
- last: Int,
2689
- "fetching only the first certain number of nodes"
2690
- limit: Int,
2691
- "Maximum depth in JCR tree for descendants from the current node, 0 (or less) for all sub nodes, 1 for one sub level, etc"
2692
- maxDepth: Int,
2693
- "fetching only nodes after this node (inclusive)"
2694
- offset: Int,
2695
- "Filter of descendant nodes by their property values; null to avoid such filtering"
2696
- propertiesFilter: InputNodePropertiesInput,
2697
- "Filter out and stop recursion on nodes by their property values; null to avoid such filtering"
2698
- recursionPropertiesFilter: InputNodePropertiesInput,
2699
- "Filter out and stop recursion on nodes by their types; null to avoid such filtering"
2700
- recursionTypesFilter: InputNodeTypesInput,
2701
- "Filter of descendant nodes by their types; null to avoid such filtering"
2702
- typesFilter: InputNodeTypesInput,
2703
- "Language to use to get children"
2704
- validInLanguage: String
2705
- ): JCRNodeConnection
2706
- "Site description"
2707
- description: String
2708
- "The displayable name of the JCR node"
2709
- displayName(
2710
- "Language"
2711
- language: String
2712
- ): String
2713
- "Returns the first parent of the current node that can be displayed in full page. If no matching node is found, null is returned."
2714
- displayableNode: JCRNode
2715
- "Returns the next available name for a node, appending if needed numbers."
2716
- findAvailableNodeName(language: String, nodeType: String): String
2717
- "Check if the current user has a specific permission"
2718
- hasPermission(
2719
- "The name of the permission"
2720
- permissionName: String!
2721
- ): Boolean
2722
- "Returns the node of the home page or null if no home page is defined or is not accessible"
2723
- homePage: JCRNode
2724
- "Retrieves a collection of module IDs, which are installed on the site, the node belongs to"
2725
- installedModules: [String]
2726
- "Retrieves a collection of module IDs, which are installed on the site, the node belongs to, as well as dependencies of those modules"
2727
- installedModulesWithAllDependencies: [String]
2728
- "Check if the node as a renderable template associated with it (not a view a template)."
2729
- isDisplayableNode: Boolean
2730
- "true if node is under a mounted node"
2731
- isExternal: Boolean!
2732
- "Reports if the current node matches the nodetype(s) passed in parameter"
2733
- isNodeType(
2734
- "Node type name"
2735
- type: InputNodeTypesInput!
2736
- ): Boolean!
2737
- "Site languages"
2738
- languages: [JCRSiteLanguage]
2739
- "Check if the given locales need translation, by comparing last modifications dates with already existing translations"
2740
- languagesToTranslate(
2741
- "The languages to check"
2742
- languagesToCheck: [String],
2743
- "The translated languages"
2744
- languagesTranslated: [String]
2745
- ): [String]
2746
- "Retrieve lock info of the current node"
2747
- lockInfo: LockInfo
2748
- "Returns edit lock status of the current node object"
2749
- lockedAndCannotBeEdited: Boolean
2750
- "Returns an array of <code>NodeType</code> objects representing the mixin node types in effect for this node."
2751
- mixinTypes(
2752
- "Filter by GraphQL fields values"
2753
- fieldFilter: InputFieldFiltersInput
2754
- ): [JCRNodeType]!
2755
- "The name of the JCR node this object represents"
2756
- name: String!
2757
- "GraphQL representation of this node in certain workspace"
2758
- nodeInWorkspace(
2759
- "The target workspace"
2760
- workspace: Workspace!
2761
- ): JCRNode
2762
- "Get information on the operations that can be done on this node"
2763
- operationsSupport: GqlOperationsSupport
2764
- "GraphQL representation of the parent JCR node"
2765
- parent: JCRNode
2766
- "The path of the JCR node this object represents"
2767
- path: String!
2768
- "Get the primary node type of this node"
2769
- primaryNodeType: JCRNodeType!
2770
- "GraphQL representations of the properties in the requested language"
2771
- properties(
2772
- "Filter by graphQL fields values"
2773
- fieldFilter: InputFieldFiltersInput,
2774
- "The language to obtain the properties in; must be a valid language code in case any internationalized properties are requested, does not matter for non-internationalized ones"
2775
- language: String,
2776
- "The names of the JCR properties; null to obtain all properties"
2777
- names: [String],
2778
- "When set to true, returns the node in the default language if there is no translation for the requested language. Returns null if the option \"Replace untranslated content with the default language content\" is not activated for the site of the requested node. Will also return null if there is no translation for the default language."
2779
- useFallbackLanguage: Boolean = false
2780
- ): [JCRProperty]!
2781
- "The GraphQL representation of the property in the requested language; null if the property does not exist"
2782
- property(
2783
- "The language to obtain the property in; must be a valid language code for internationalized properties, does not matter for non-internationalized ones"
2784
- language: String,
2785
- "The name of the JCR property"
2786
- name: String!,
2787
- "When set to true, returns the node in the default language if there is no translation for the requested language. Returns null if the option \"Replace untranslated content with the default language content\" is not activated for the site of the requested node. Will also return null if there is no translation for the default language."
2788
- useFallbackLanguage: Boolean = false
2789
- ): JCRProperty
2790
- "Returns count of all references of the node across all sites"
2791
- referenceCount(
2792
- "Filter out referencing types which should not be counted"
2793
- typesFilter: InputNodeTypesInput
2794
- ): Int
2795
- "GraphQL representations of the reference properties that target the current JCR Node"
2796
- references(
2797
- "fetching only nodes after this node (exclusive)"
2798
- after: String,
2799
- "fetching only nodes before this node (exclusive)"
2800
- before: String,
2801
- "Filter by graphQL fields values"
2802
- fieldFilter: InputFieldFiltersInput,
2803
- "Sort by graphQL fields values"
2804
- fieldSorter: InputFieldSorterInput,
2805
- "fetching only the first certain number of nodes"
2806
- first: Int,
2807
- "fetching only the last certain number of nodes"
2808
- last: Int,
2809
- "fetching only the first certain number of nodes"
2810
- limit: Int,
2811
- "fetching only nodes after this node (inclusive)"
2812
- offset: Int
2813
- ): JCRPropertyConnection!
2814
- "Get render URL."
2815
- renderUrl(
2816
- "Finds displayable node"
2817
- findDisplayable: Boolean = false,
2818
- "The language content is rendered in"
2819
- language: String!,
2820
- "The target workspace"
2821
- workspace: Workspace!
2822
- ): String
2823
- "Gets the fully rendered content for this node"
2824
- renderedContent(
2825
- "Rendering context configuration"
2826
- contextConfiguration: String,
2827
- "Is edit mode"
2828
- isEditMode: Boolean,
2829
- "Language"
2830
- language: String,
2831
- "Main resource path"
2832
- mainResourcePath: String,
2833
- "Additional request attributes"
2834
- requestAttributes: [InputRenderRequestAttributeInput],
2835
- "Template type"
2836
- templateType: String,
2837
- "Name of the view (leave null for default)"
2838
- view: String
2839
- ): RenderedNode
2840
- "Site server name"
2841
- serverName: String
2842
- "GraphQL representation of the site the JCR node belongs to, or the system site in case the node does not belong to any site"
2843
- site: JCRSite
2844
- "Site key"
2845
- sitekey: String
2846
- "Get node thumbnail URL"
2847
- thumbnailUrl(
2848
- "Optional: Checks if requested thumbnail node exists, returns null if it doesn't"
2849
- checkIfExists: Boolean = false,
2850
- "Thumbnail name"
2851
- name: String
2852
- ): String
2853
- "Returns languages of available translations for this node"
2854
- translationLanguages(
2855
- "Optional: Return languages only if it is active for the site"
2856
- isActiveOnly: Boolean
2857
- ): [String]
2858
- "Get node URL"
2859
- url: String
2860
- "GraphQL representations of the reference properties that target the current JCR Node"
2861
- usages(
2862
- "fetching only nodes after this node (exclusive)"
2863
- after: String,
2864
- "fetching only nodes before this node (exclusive)"
2865
- before: String,
2866
- "Filter by graphQL fields values"
2867
- fieldFilter: InputFieldFiltersInput,
2868
- "Sort by graphQL fields values"
2869
- fieldSorter: InputFieldSorterInput,
2870
- "fetching only the first certain number of nodes"
2871
- first: Int,
2872
- "fetching only the last certain number of nodes"
2873
- last: Int,
2874
- "fetching only the first certain number of nodes"
2875
- limit: Int,
2876
- "fetching only nodes after this node (inclusive)"
2877
- offset: Int
2878
- ): UsageConnection!
2879
- "The UUID of the JCR node this object represents"
2880
- uuid: String!
2881
- "Get vanity URLs from the current node filtered by the parameters"
2882
- vanityUrls(
2883
- "Filter results based on graphql field values"
2884
- fieldFilter: InputFieldFiltersInput,
2885
- "Languages"
2886
- languages: [String]
2887
- ): [VanityUrl]
2888
- "Read work in progress information for a given node"
2889
- wipInfo: wipInfo
2890
- "Get the workspace of the query"
2891
- workspace: Workspace!
2892
- }
2893
-
2894
- "Site language representation"
2895
- type JCRSiteLanguage {
2896
- "Is this language active in edit"
2897
- activeInEdit: Boolean
2898
- "Is this language active in live"
2899
- activeInLive: Boolean
2900
- "Display name"
2901
- displayName(
2902
- "Language"
2903
- language: String
2904
- ): String
2905
- "Language code"
2906
- language: String
2907
- "Is this language mandatory"
2908
- mandatory: Boolean
2909
- }
2910
-
2911
- "GraphQL representation of a Tag"
2912
- type JCRTag {
2913
- "The name of the tag"
2914
- name: String!
2915
- "Get the occurences of a tag"
2916
- occurences: Long!
2917
- }
2918
-
2919
- "JCR Queries"
2920
- type JCRTags {
2921
- "Handles suggestion tags queries"
2922
- suggest(
2923
- "Max number of tags to get"
2924
- limit: Long!,
2925
- "Minimal occurrences to return a tag"
2926
- minCount: Long,
2927
- "Offset value"
2928
- offset: Long,
2929
- "The prefix of the tags"
2930
- prefix: String!,
2931
- "Sort the tags by occurrences"
2932
- sortByCount: Boolean,
2933
- "The root node to start the search"
2934
- startPath: String!
2935
- ): [JCRTag]
2936
- }
2937
-
2938
- type JWTToken {
2939
- claims: String
2940
- id: String
2941
- token: String
2942
- }
2943
-
2944
- "Admin mutations"
2945
- type JahiaAdminMutation {
2946
- "Mutate an OSGi configuration"
2947
- configuration(
2948
- "If factory pid, configiration identifier (filename suffix)"
2949
- identifier: String,
2950
- "Configuration pid ot factory pid"
2951
- pid: String!,
2952
- "Do not create new configuration, update existing one"
2953
- updateOnly: Boolean = false
2954
- ): GqlConfigurationMutation
2955
- "Create a task"
2956
- createTask(
2957
- "Task name"
2958
- name: String!,
2959
- "Service name"
2960
- service: String!
2961
- ): Boolean
2962
- "Delete a task"
2963
- deleteTask(
2964
- "Task name"
2965
- name: String!,
2966
- "Service name"
2967
- service: String!
2968
- ): Boolean
2969
- "Shutdown the server"
2970
- shutdown(
2971
- "Do not send the shutdown event"
2972
- dryRun: Boolean,
2973
- "Force immediate shutdown even if server is busy"
2974
- force: Boolean,
2975
- "In seconds, maximum time to wait for server to be ready to shutdown"
2976
- timeout: Int
2977
- ): Boolean
2978
- }
2979
-
2980
- "Jahia admin queries root"
2981
- type JahiaAdminQuery {
2982
- "Read an OSGi configuration"
2983
- configuration(
2984
- "If factory pid, configuration identifier (filename suffix)"
2985
- identifier: String,
2986
- "Configuration pid ot factory pid"
2987
- pid: String!
2988
- ): GqlConfigurationQuery
2989
- "Details about the database Jahia is connected to"
2990
- database: JahiaDatabase
2991
- "HealthCheck node"
2992
- healthCheck(
2993
- "Returns only SAM probes with probe names included in this list"
2994
- includes: [String!],
2995
- "Returns SAM probes with this severity or higher"
2996
- severity: GqlProbeSeverity
2997
- ): GqlHealthCheck
2998
- "Get server load"
2999
- load: Load
3000
- "Get jobs scheduler"
3001
- scheduler: GqlScheduler
3002
- "Details about the system hosting Jahia"
3003
- system: JahiaSystem
3004
- "Lists tasks running on the Jahia server. A server should not be stopped/restarted when any of these tasks are present. These tasks are specific to the server being queried and are not shared accorss a cluster"
3005
- tasks: [task]
3006
- "Version of the running Jahia instance"
3007
- version: JahiaVersion
3008
- }
3009
-
3010
- "Details about the database Jahia is connected to"
3011
- type JahiaDatabase {
3012
- "Name of the driver used to connect to the database"
3013
- driverName: String
3014
- "Version of the driver used to connect to the database"
3015
- driverVersion: String
3016
- "Name of the database vendor"
3017
- name: String
3018
- "Type of database specified in Jahia configuration"
3019
- type: String
3020
- "Version of the database"
3021
- version: String
3022
- }
3023
-
3024
- "Details about the system used to run Jahia"
3025
- type JahiaSystem {
3026
- "Details about the operating system"
3027
- java: JahiaSystemJava
3028
- "Details about the operating system"
3029
- os: JahiaSystemOs
3030
- }
3031
-
3032
- "Details about the system OS used to run Jahia"
3033
- type JahiaSystemJava {
3034
- "Java Runtime name"
3035
- runtimeName: String
3036
- "Java Runtime version"
3037
- runtimeVersion: String
3038
- "Java vendor"
3039
- vendor: String
3040
- "Java vendor version"
3041
- vendorVersion: String
3042
- }
3043
-
3044
- "Details about the system OS used to run Jahia"
3045
- type JahiaSystemOs {
3046
- "Operating System Architecture (amd64, arm64, ...)"
3047
- architecture: String
3048
- "Operating System Name"
3049
- name: String
3050
- "Operating System Version"
3051
- version: String
3052
- }
3053
-
3054
- "Version of the running Jahia instance"
3055
- type JahiaVersion {
3056
- "Build number of the running Jahia instance"
3057
- build: String
3058
- "Build date of the running Jahia instance"
3059
- buildDate: String
3060
- "Flag returning if running Jahia instance is a SNAPSHOT"
3061
- isSnapshot: Boolean
3062
- "Release of the running Jahia instance"
3063
- release: String
3064
- }
3065
-
3066
- "Details about the Jahia cluster journal"
3067
- type Journal {
3068
- "The latest revision of the journal on the cluster"
3069
- globalRevision: Long
3070
- "Is the journal in sync across all nodes of a cluster"
3071
- isClusterSync: Boolean
3072
- "The latest revision of the journal on the current node"
3073
- localRevision: JournalRevision
3074
- "The latest revisions of the journal for all cluster nodes"
3075
- revisions: [JournalRevision]
3076
- }
3077
-
3078
- "Details about one journal revision"
3079
- type JournalRevision {
3080
- "The revision"
3081
- revision: Long
3082
- "The cluster node server Id"
3083
- serverId: String
3084
- }
3085
-
3086
- "Server load"
3087
- type Load {
3088
- "Get JCR Node Cache load across active sessions"
3089
- cachedNodes: LoadProvider
3090
- "Get requests load"
3091
- requests: LoadProvider
3092
- "Get JCR Sessions load"
3093
- sessions: LoadProvider
3094
- "Get Thread load"
3095
- thread: LoadProvider
3096
- }
3097
-
3098
- "Load provider"
3099
- type LoadProvider {
3100
- "Exponential moving average"
3101
- average(
3102
- "Interval between collection of load metrics"
3103
- interval: LoadInterval
3104
- ): Float
3105
- "Instantaneous count"
3106
- count: Float
3107
- "Load Entry"
3108
- entry: String
3109
- }
3110
-
3111
- "Information on node lock"
3112
- type LockInfo {
3113
- "Can the node be locked"
3114
- canLock: Boolean
3115
- "Can the node be unlocked"
3116
- canUnlock: Boolean
3117
- "Is node lockable"
3118
- details(
3119
- "language in which to retrieve details"
3120
- language: String
3121
- ): [GqlLockDetail]
3122
- "Is node lockable"
3123
- lockable: Boolean
3124
- }
3125
-
3126
- "Metadata properties for all content"
3127
- type Metadata {
3128
- "Date of creation for the associated content"
3129
- created: Date
3130
- "Original author of the associated content"
3131
- createdBy: String
3132
- "Date of last modification of the associated content"
3133
- lastModified: Date
3134
- "Author of last modification of the associated content"
3135
- lastModifiedBy: String
3136
- "Date of last publication of the associated content"
3137
- lastPublished: Date
3138
- "Author of last publication of the associated content"
3139
- lastPublishedBy: String
3140
- }
3141
-
3142
- "Root mutation type"
3143
- type Mutation {
3144
- "Admin Mutation"
3145
- admin: AdminMutation!
3146
- "Main access field to the DX GraphQL Form mutation API"
3147
- forms: GqlEditorFormMutations
3148
- "Main access field to the jContent mutation API"
3149
- jcontent: GqlJContentMutations
3150
- "JCR Mutation"
3151
- jcr(
3152
- "Should save"
3153
- save: Boolean = true,
3154
- "The name of the workspace to fetch the node from; either 'edit', 'live', or null to use 'edit' by default"
3155
- workspace: Workspace
3156
- ): JCRMutation
3157
- "Generate a new JWT token"
3158
- jwtToken(ips: [String], referer: [String], scopes: [String]!): JWTToken
3159
- mutateWorkflows(definition: String): [WorkflowMutation]
3160
- }
3161
-
3162
- "GraphQL representation of node type tree entry"
3163
- type NodeTypeTreeEntry {
3164
- "Return the children if any"
3165
- children: [NodeTypeTreeEntry]
3166
- "Return icon URL with png extension"
3167
- iconURL(
3168
- "if true (default) add '.png' to the icon path."
3169
- addExtension: Boolean = true
3170
- ): String
3171
- "Return uniq identifier for tree entry"
3172
- id: String
3173
- "Return the i18n label"
3174
- label: String
3175
- "Return nodeType name"
3176
- name: String
3177
- "Return nodeType"
3178
- nodeType: JCRNodeType
3179
- "Return the parent tree entry (if any)"
3180
- parent: NodeTypeTreeEntry
3181
- }
3182
-
3183
- "Information about pagination in a connection."
3184
- type PageInfo {
3185
- "When paginating forwards, the cursor to continue."
3186
- endCursor: String
3187
- "When paginating forwards, are there more items?"
3188
- hasNextPage: Boolean!
3189
- "When paginating backwards, are there more items?"
3190
- hasPreviousPage: Boolean!
3191
- "When paginating forwards, the cursor to continue."
3192
- nodesCount: Int
3193
- "When paginating backwards, the cursor to continue."
3194
- startCursor: String
3195
- "When paginating forwards, the cursor to continue."
3196
- totalCount: Int
3197
- }
3198
-
3199
- "Token details"
3200
- type PersonalApiToken {
3201
- "Creation date and time"
3202
- createdAt: String
3203
- "Expiration date"
3204
- expireAt: String
3205
- "The key of the token, used for looking it up"
3206
- key: String
3207
- "The name of the token"
3208
- name: String
3209
- "Token state"
3210
- state: TokenState
3211
- "Last modification date and time"
3212
- updatedAt: String
3213
- "The user associated to the token"
3214
- user: User
3215
- }
3216
-
3217
- "A connection to a list of items."
3218
- type PersonalApiTokenConnection {
3219
- "a list of edges"
3220
- edges: [PersonalApiTokenEdge]
3221
- "a list of nodes"
3222
- nodes: [PersonalApiToken]
3223
- "details about this specific page"
3224
- pageInfo: PageInfo!
3225
- }
3226
-
3227
- "An edge in a connection"
3228
- type PersonalApiTokenEdge {
3229
- "cursor marks a unique position or index into the connection"
3230
- cursor: String!
3231
- "index in the connection"
3232
- index: Int
3233
- "The item at the end of the edge"
3234
- node: PersonalApiToken
3235
- }
3236
-
3237
- "Mutations for Personal Api Tokens"
3238
- type PersonalApiTokensMutation {
3239
- "Create a new token"
3240
- createToken(
3241
- "Expiration date of the token"
3242
- expireAt: String,
3243
- "Name to give to the token"
3244
- name: String!,
3245
- "Scopes attached to this token"
3246
- scopes: [String],
3247
- "The site the user belongs to, null if global user"
3248
- site: String,
3249
- "State to give the newly created token"
3250
- state: TokenState
3251
- ): String
3252
- "Delete an existing token"
3253
- deleteToken(
3254
- "The token key"
3255
- key: String!
3256
- ): Boolean
3257
- "Update an existing token"
3258
- updateToken(
3259
- "Expiration date of the token, use empty string to unset expiration date"
3260
- expireAt: String,
3261
- "The token key"
3262
- key: String!,
3263
- "Name to give to the token"
3264
- name: String,
3265
- "Scopes attached to this token"
3266
- scopes: [String],
3267
- "State to give the token"
3268
- state: TokenState
3269
- ): Boolean
3270
- }
3271
-
3272
- "Queries for Personal Api Tokens"
3273
- type PersonalApiTokensQuery {
3274
- "Get available scopes"
3275
- availableScopes: [GqlScope]
3276
- "Get token details, based on key"
3277
- tokenByKey(
3278
- "The token key"
3279
- key: String!
3280
- ): PersonalApiToken
3281
- "Get token details, based on user and token name"
3282
- tokenByUserAndName(
3283
- "The site the user belongs to, null if global user"
3284
- site: String,
3285
- "The token name"
3286
- tokenName: String!,
3287
- "The user id"
3288
- userId: String!
3289
- ): PersonalApiToken
3290
- "List tokens attached to the provided user ID and site key"
3291
- tokens(
3292
- "fetching only nodes after this node (exclusive)"
3293
- after: String,
3294
- "fetching only nodes before this node (exclusive)"
3295
- before: String,
3296
- "Sort by graphQL fields values"
3297
- fieldSorter: InputFieldSorterInput,
3298
- "fetching only the first certain number of nodes"
3299
- first: Int,
3300
- "fetching only the last certain number of nodes"
3301
- last: Int,
3302
- "fetching only the first certain number of nodes"
3303
- limit: Int,
3304
- "fetching only nodes after this node (inclusive)"
3305
- offset: Int,
3306
- "The site the user belongs to, null if global user"
3307
- site: String,
3308
- "If a userId is provided, only returns tokens assigned to that user."
3309
- userId: String
3310
- ): PersonalApiTokenConnection
3311
- "Check if the token is valid for authentication"
3312
- verifyToken(
3313
- "The token"
3314
- token: String!
3315
- ): Boolean
3316
- }
3317
-
3318
- "A connection to a list of items."
3319
- type PrincipalConnection {
3320
- "a list of edges"
3321
- edges: [PrincipalEdge]
3322
- "a list of nodes"
3323
- nodes: [Principal]
3324
- "details about this specific page"
3325
- pageInfo: PageInfo!
3326
- }
3327
-
3328
- "An edge in a connection"
3329
- type PrincipalEdge {
3330
- "cursor marks a unique position or index into the connection"
3331
- cursor: String!
3332
- "index in the connection"
3333
- index: Int
3334
- "The item at the end of the edge"
3335
- node: Principal
3336
- }
3337
-
3338
- "Root query type"
3339
- type Query {
3340
- "Admin Queries"
3341
- admin: AdminQuery!
3342
- "default finder for categoryById"
3343
- categoryById(
3344
- "Node identifier"
3345
- id: String,
3346
- "Content language, defaults to English"
3347
- language: String = "en",
3348
- "Return content from live or default workspace"
3349
- preview: Boolean = false
3350
- ): Category
3351
- "default finder for categoryByPath"
3352
- categoryByPath(
3353
- "Content language, defaults to English"
3354
- language: String = "en",
3355
- "Path of the node"
3356
- path: String,
3357
- "Return content from live or default workspace"
3358
- preview: Boolean = false
3359
- ): Category
3360
- "Get the current user"
3361
- currentUser: Current_32_user
3362
- "Main access field to the DX GraphQL Dashboard API"
3363
- dashboard: GqlDashboard
3364
- "Main access field to the DX GraphQL Form API"
3365
- forms: GqlEditorForms
3366
- "Main access field to the jContent API"
3367
- jcontent: GqlJContent
3368
- "JCR Queries"
3369
- jcr(
3370
- "The name of the workspace to fetch the node from; either EDIT, LIVE, or null to use EDIT by default"
3371
- workspace: Workspace
3372
- ): JCRQuery!
3373
- "Tag Queries"
3374
- tag: JCRTags
3375
- "Retrieves the number of active workflow tasks for the current user"
3376
- workflow: WorkflowService
3377
- }
3378
-
3379
- "Rendering result for a node"
3380
- type RenderedNode {
3381
- "Contraints on this node"
3382
- constraints: String
3383
- "Rendering output"
3384
- output: String
3385
- "List of static assets"
3386
- staticAssets(
3387
- "Assets type"
3388
- type: String!
3389
- ): [StaticAsset]
3390
- }
3391
-
3392
- "Simple numeric aggregation on properties values"
3393
- type StatAggregation {
3394
- "The date representation of a JCR node property"
3395
- datePropertyValue(
3396
- "The language to obtain the property in; must be a valid language code for internationalized properties, does not matter for non-internationalized ones"
3397
- language: String,
3398
- "The name of the JCR property"
3399
- name: String!
3400
- ): String
3401
- "The float representation of a JCR node property"
3402
- floatPropertyValue(
3403
- "The language to obtain the property in; must be a valid language code for internationalized properties, does not matter for non-internationalized ones"
3404
- language: String,
3405
- "The name of the JCR property"
3406
- name: String!
3407
- ): Float
3408
- "The long representation of a JCR node property"
3409
- longPropertyValue(
3410
- "The language to obtain the property in; must be a valid language code for internationalized properties, does not matter for non-internationalized ones"
3411
- language: String,
3412
- "The name of the JCR property"
3413
- name: String!
3414
- ): Long
3415
- }
3416
-
3417
- "Representation of a static assert"
3418
- type StaticAsset {
3419
- "Asset key"
3420
- key: String
3421
- "Asset option"
3422
- option(
3423
- "Asset option name"
3424
- name: String!
3425
- ): String
3426
- }
3427
-
3428
- "Root subscription type"
3429
- type Subscription {
3430
- "Subscription on background jobs"
3431
- backgroundJobSubscription(
3432
- "Subscribe only to job with matching group names"
3433
- filterByGroups: [String],
3434
- "Subscribe only to job with matching job states"
3435
- filterByJobStates: [GqlBackgroundJobState],
3436
- "Subscribe only to job with matching job statuses"
3437
- filterByJobStatuses: [GqlBackgroundJobStatus],
3438
- "Subscribe only to job with matching names"
3439
- filterByNames: [String],
3440
- "Subscribe only to job with matching user keys"
3441
- filterByUserKey: [String],
3442
- "The target scheduler for listening jobs"
3443
- targetScheduler: TargetScheduler = BOTH
3444
- ): GqlBackgroundJob @deprecated(reason: "Use subscribeToPublicationJob instead")
3445
- "Lock the node for edition and subscribe to hold the lock. The node is automatically unlocked when the client disconnect or close the connection"
3446
- subscribeToEditorLock(
3447
- "An ID generated client side used to identify the lock"
3448
- editorID: String!,
3449
- "Uuid of the node to be locked."
3450
- nodeId: String!
3451
- ): String
3452
- "Subscription on publication jobs"
3453
- subscribeToPublicationJob(
3454
- "Subscribe only to job with matching user keys"
3455
- userKeyFilter: [String]
3456
- ): GqlPublicationEvent
3457
- "Subscription on workflows"
3458
- workflowEvent: GqlWorkflowEvent
3459
- }
3460
-
3461
- "Workflow task"
3462
- type Task {
3463
- "Task assignee"
3464
- assignee: User
3465
- "Creation time"
3466
- creationTime: String
3467
- "Due date"
3468
- dueDate: String
3469
- "Task id"
3470
- id: String
3471
- "Task name"
3472
- name: String
3473
- "Parent workflow"
3474
- workflow: Workflow
3475
- }
3476
-
3477
- "A connection to a list of items."
3478
- type TaskConnection {
3479
- "a list of edges"
3480
- edges: [TaskEdge]
3481
- "a list of nodes"
3482
- nodes: [Task]
3483
- "details about this specific page"
3484
- pageInfo: PageInfo!
3485
- }
3486
-
3487
- "An edge in a connection"
3488
- type TaskEdge {
3489
- "cursor marks a unique position or index into the connection"
3490
- cursor: String!
3491
- "index in the connection"
3492
- index: Int
3493
- "The item at the end of the edge"
3494
- node: Task
3495
- }
3496
-
3497
- "GraphQL representation of a usage (node holding the reference + list of properties referencing the caller)"
3498
- type Usage {
3499
- "The GraphQL representation of the JCR node the property belongs to."
3500
- node: JCRNode!
3501
- "The GraphQL representation of the references on this node."
3502
- properties: [JCRProperty]!
3503
- }
3504
-
3505
- "A connection to a list of items."
3506
- type UsageConnection {
3507
- "a list of edges"
3508
- edges: [UsageEdge]
3509
- "a list of nodes"
3510
- nodes: [Usage]
3511
- "details about this specific page"
3512
- pageInfo: PageInfo!
3513
- }
3514
-
3515
- "An edge in a connection"
3516
- type UsageEdge {
3517
- "cursor marks a unique position or index into the connection"
3518
- cursor: String!
3519
- "index in the connection"
3520
- index: Int
3521
- "The item at the end of the edge"
3522
- node: Usage
3523
- }
3524
-
3525
- "GraphQL representation of a Jahia user"
3526
- type User implements Principal {
3527
- "Full display name"
3528
- displayName: String
3529
- "Email of the user"
3530
- email: String
3531
- "First name of the user"
3532
- firstname: String
3533
- "List of groups this principal belongs to"
3534
- groupMembership(
3535
- "fetching only nodes after this node (exclusive)"
3536
- after: String,
3537
- "fetching only nodes before this node (exclusive)"
3538
- before: String,
3539
- "Filter by graphQL fields values"
3540
- fieldFilter: InputFieldFiltersInput,
3541
- "Group fields according to specified criteria"
3542
- fieldGrouping: InputFieldGroupingInput,
3543
- "Sort by graphQL fields values"
3544
- fieldSorter: InputFieldSorterInput,
3545
- "fetching only the first certain number of nodes"
3546
- first: Int,
3547
- "fetching only the last certain number of nodes"
3548
- last: Int,
3549
- "fetching only the first certain number of nodes"
3550
- limit: Int,
3551
- "fetching only nodes after this node (inclusive)"
3552
- offset: Int,
3553
- "Return only groups which belong to this site"
3554
- site: String
3555
- ): GroupConnection!
3556
- "Preferred language by the user"
3557
- language: String
3558
- "Last name of the user"
3559
- lastname: String
3560
- "Displays if user is locked"
3561
- locked: Boolean
3562
- "Is this principal member of the specified group"
3563
- memberOf(
3564
- "Target group"
3565
- group: String,
3566
- "Site where the group is defined"
3567
- site: String
3568
- ): Boolean
3569
- "User name"
3570
- name: String! @deprecated(reason: "Deprecated")
3571
- "Get the corresponding JCR node"
3572
- node: JCRNode
3573
- "User organization"
3574
- organization: String
3575
- "Return USER principal type"
3576
- principalType: PrincipalType
3577
- "User property"
3578
- property(
3579
- "The name of the property"
3580
- name: String!
3581
- ): String
3582
- "Site where the user is defined"
3583
- site: JCRSite
3584
- "Username of the user"
3585
- username: String!
3586
- }
3587
-
3588
- "User admin queries"
3589
- type UserAdminQuery {
3590
- "Get a user"
3591
- user(
3592
- "Site where the user is defined"
3593
- site: String,
3594
- "User name"
3595
- username: String!
3596
- ): User
3597
- "Get users list"
3598
- users(
3599
- "fetching only nodes after this node (exclusive)"
3600
- after: String,
3601
- "fetching only nodes before this node (exclusive)"
3602
- before: String,
3603
- "Filter by graphQL fields values"
3604
- fieldFilter: InputFieldFiltersInput,
3605
- "Group fields according to specified criteria"
3606
- fieldGrouping: InputFieldGroupingInput,
3607
- "Sort by graphQL fields values"
3608
- fieldSorter: InputFieldSorterInput,
3609
- "fetching only the first certain number of nodes"
3610
- first: Int,
3611
- "fetching only the last certain number of nodes"
3612
- last: Int,
3613
- "fetching only the first certain number of nodes"
3614
- limit: Int,
3615
- "fetching only nodes after this node (inclusive)"
3616
- offset: Int
3617
- ): UserConnection
3618
- }
3619
-
3620
- "A connection to a list of items."
3621
- type UserConnection {
3622
- "a list of edges"
3623
- edges: [UserEdge]
3624
- "a list of nodes"
3625
- nodes: [User]
3626
- "details about this specific page"
3627
- pageInfo: PageInfo!
3628
- }
3629
-
3630
- "An edge in a connection"
3631
- type UserEdge {
3632
- "cursor marks a unique position or index into the connection"
3633
- cursor: String!
3634
- "index in the connection"
3635
- index: Int
3636
- "The item at the end of the edge"
3637
- node: User
3638
- }
3639
-
3640
- "User group queries"
3641
- type UserGroupQuery {
3642
- "Get a group"
3643
- group(
3644
- "Group name"
3645
- groupName: String!,
3646
- "Site where the group is defined"
3647
- site: String
3648
- ): Group
3649
- }
3650
-
3651
- "GraphQL representation of a vanity URL"
3652
- type VanityUrl implements JCRNode {
3653
- "Get ACL info for this node"
3654
- acl: GqlAcl
3655
- "true if the URL mapping is activated or false if it is not activated"
3656
- active: Boolean
3657
- "Get the last modified date of this node and its descendants. The recursion in descendants can be controlled by recursionTypesFilter. If no filter is passed, recursion will stop by default on sub pages."
3658
- aggregatedLastModifiedDate(
3659
- "The language"
3660
- language: String,
3661
- "Stop recursion on graphql field values"
3662
- recursionTypesFilter: InputNodeTypesInput
3663
- ): String
3664
- "Aggregated publication info about the JCR node"
3665
- aggregatedPublicationInfo(
3666
- "Publication language"
3667
- language: String!,
3668
- "Whether to take references into account when calculating the aggregated publication status"
3669
- references: Boolean = false,
3670
- "Whether to take sub-nodes into account when calculating the aggregated publication status"
3671
- subNodes: Boolean = false
3672
- ): GqlPublicationInfo!
3673
- "Render URL in ajax mode"
3674
- ajaxRenderUrl: String
3675
- "Returns a list of types allowed under the provided node"
3676
- allowedChildNodeTypes(
3677
- "Filter by GraphQL fields values"
3678
- fieldFilter: InputFieldFiltersInput,
3679
- "Whether all sub-types of allowed child node types should be included"
3680
- includeSubTypes: Boolean = true
3681
- ): [JCRNodeType]
3682
- "GraphQL representations of the ancestor nodes of the JCR node, top down direction"
3683
- ancestors(
3684
- "Filter by graphQL fields values"
3685
- fieldFilter: InputFieldFiltersInput,
3686
- "The path of the topmost ancestor node to include in the result; null or empty string to include all the ancestor nodes"
3687
- upToPath: String
3688
- ): [JCRNode]!
3689
- "GraphQL representations of the child nodes, according to parameters passed"
3690
- children(
3691
- "fetching only nodes after this node (exclusive)"
3692
- after: String,
3693
- "fetching only nodes before this node (exclusive)"
3694
- before: String,
3695
- "Filter by graphQL fields values"
3696
- fieldFilter: InputFieldFiltersInput,
3697
- "Group fields according to specified criteria"
3698
- fieldGrouping: InputFieldGroupingInput,
3699
- "Sort by graphQL fields values"
3700
- fieldSorter: InputFieldSorterInput,
3701
- "fetching only the first certain number of nodes"
3702
- first: Int,
3703
- "Include the current node itself in results"
3704
- includesSelf: Boolean = false,
3705
- "fetching only the last certain number of nodes"
3706
- last: Int,
3707
- "fetching only the first certain number of nodes"
3708
- limit: Int,
3709
- "Filter of child nodes by their names; null to avoid such filtering"
3710
- names: [String],
3711
- "fetching only nodes after this node (inclusive)"
3712
- offset: Int,
3713
- "Filter of child nodes by their property values; null to avoid such filtering"
3714
- propertiesFilter: InputNodePropertiesInput,
3715
- "Filter of child nodes by their types; null to avoid such filtering"
3716
- typesFilter: InputNodeTypesInput,
3717
- "Language to use to get children"
3718
- validInLanguage: String
3719
- ): JCRNodeConnection
3720
- "true whether this URL mapping is the default one for the language"
3721
- default: Boolean
3722
- "Read default Work in progress information. Set by \"wip.checkbox.checked\" system proprety"
3723
- defaultWipInfo: wipInfo
3724
- "Returns the node definition that applies to this node."
3725
- definition: JCRNodeDefinition
3726
- "The depth in the JCR Tree of the JCR node this object represents"
3727
- depth: Int!
3728
- "GraphQL representation of a descendant node, based on its relative path"
3729
- descendant(
3730
- "Name or relative path of the sub node"
3731
- relPath: String!
3732
- ): JCRNode
3733
- "GraphQL representations of the descendant nodes, according to parameters passed"
3734
- descendants(
3735
- "fetching only nodes after this node (exclusive)"
3736
- after: String,
3737
- "fetching only nodes before this node (exclusive)"
3738
- before: String,
3739
- "Filter by graphQL fields values"
3740
- fieldFilter: InputFieldFiltersInput,
3741
- "Group fields according to specified criteria"
3742
- fieldGrouping: InputFieldGroupingInput,
3743
- "Sort by graphQL fields values"
3744
- fieldSorter: InputFieldSorterInput,
3745
- "fetching only the first certain number of nodes"
3746
- first: Int,
3747
- "fetching only the last certain number of nodes"
3748
- last: Int,
3749
- "fetching only the first certain number of nodes"
3750
- limit: Int,
3751
- "Maximum depth in JCR tree for descendants from the current node, 0 (or less) for all sub nodes, 1 for one sub level, etc"
3752
- maxDepth: Int,
3753
- "fetching only nodes after this node (inclusive)"
3754
- offset: Int,
3755
- "Filter of descendant nodes by their property values; null to avoid such filtering"
3756
- propertiesFilter: InputNodePropertiesInput,
3757
- "Filter out and stop recursion on nodes by their property values; null to avoid such filtering"
3758
- recursionPropertiesFilter: InputNodePropertiesInput,
3759
- "Filter out and stop recursion on nodes by their types; null to avoid such filtering"
3760
- recursionTypesFilter: InputNodeTypesInput,
3761
- "Filter of descendant nodes by their types; null to avoid such filtering"
3762
- typesFilter: InputNodeTypesInput,
3763
- "Language to use to get children"
3764
- validInLanguage: String
3765
- ): JCRNodeConnection
3766
- "The displayable name of the JCR node"
3767
- displayName(
3768
- "Language"
3769
- language: String
3770
- ): String
3771
- "Returns the first parent of the current node that can be displayed in full page. If no matching node is found, null is returned."
3772
- displayableNode: JCRNode
3773
- "Returns the next available name for a node, appending if needed numbers."
3774
- findAvailableNodeName(language: String, nodeType: String): String
3775
- "Check if the current user has a specific permission"
3776
- hasPermission(
3777
- "The name of the permission"
3778
- permissionName: String!
3779
- ): Boolean
3780
- "Check if the node as a renderable template associated with it (not a view a template)."
3781
- isDisplayableNode: Boolean
3782
- "true if node is under a mounted node"
3783
- isExternal: Boolean!
3784
- "Reports if the current node matches the nodetype(s) passed in parameter"
3785
- isNodeType(
3786
- "Node type name"
3787
- type: InputNodeTypesInput!
3788
- ): Boolean!
3789
- "The language of the content object to which the vanity URL maps to"
3790
- language: String
3791
- "Check if the given locales need translation, by comparing last modifications dates with already existing translations"
3792
- languagesToTranslate(
3793
- "The languages to check"
3794
- languagesToCheck: [String],
3795
- "The translated languages"
3796
- languagesTranslated: [String]
3797
- ): [String]
3798
- "Retrieve lock info of the current node"
3799
- lockInfo: LockInfo
3800
- "Returns edit lock status of the current node object"
3801
- lockedAndCannotBeEdited: Boolean
3802
- "Returns an array of <code>NodeType</code> objects representing the mixin node types in effect for this node."
3803
- mixinTypes(
3804
- "Filter by GraphQL fields values"
3805
- fieldFilter: InputFieldFiltersInput
3806
- ): [JCRNodeType]!
3807
- "The name of the JCR node this object represents"
3808
- name: String!
3809
- "GraphQL representation of this node in certain workspace"
3810
- nodeInWorkspace(
3811
- "The target workspace"
3812
- workspace: Workspace!
3813
- ): JCRNode
3814
- "Get information on the operations that can be done on this node"
3815
- operationsSupport: GqlOperationsSupport
3816
- "GraphQL representation of the parent JCR node"
3817
- parent: JCRNode
3818
- "The path of the JCR node this object represents"
3819
- path: String!
3820
- "Get the primary node type of this node"
3821
- primaryNodeType: JCRNodeType!
3822
- "GraphQL representations of the properties in the requested language"
3823
- properties(
3824
- "Filter by graphQL fields values"
3825
- fieldFilter: InputFieldFiltersInput,
3826
- "The language to obtain the properties in; must be a valid language code in case any internationalized properties are requested, does not matter for non-internationalized ones"
3827
- language: String,
3828
- "The names of the JCR properties; null to obtain all properties"
3829
- names: [String],
3830
- "When set to true, returns the node in the default language if there is no translation for the requested language. Returns null if the option \"Replace untranslated content with the default language content\" is not activated for the site of the requested node. Will also return null if there is no translation for the default language."
3831
- useFallbackLanguage: Boolean = false
3832
- ): [JCRProperty]!
3833
- "The GraphQL representation of the property in the requested language; null if the property does not exist"
3834
- property(
3835
- "The language to obtain the property in; must be a valid language code for internationalized properties, does not matter for non-internationalized ones"
3836
- language: String,
3837
- "The name of the JCR property"
3838
- name: String!,
3839
- "When set to true, returns the node in the default language if there is no translation for the requested language. Returns null if the option \"Replace untranslated content with the default language content\" is not activated for the site of the requested node. Will also return null if there is no translation for the default language."
3840
- useFallbackLanguage: Boolean = false
3841
- ): JCRProperty
3842
- "Returns count of all references of the node across all sites"
3843
- referenceCount(
3844
- "Filter out referencing types which should not be counted"
3845
- typesFilter: InputNodeTypesInput
3846
- ): Int
3847
- "GraphQL representations of the reference properties that target the current JCR Node"
3848
- references(
3849
- "fetching only nodes after this node (exclusive)"
3850
- after: String,
3851
- "fetching only nodes before this node (exclusive)"
3852
- before: String,
3853
- "Filter by graphQL fields values"
3854
- fieldFilter: InputFieldFiltersInput,
3855
- "Sort by graphQL fields values"
3856
- fieldSorter: InputFieldSorterInput,
3857
- "fetching only the first certain number of nodes"
3858
- first: Int,
3859
- "fetching only the last certain number of nodes"
3860
- last: Int,
3861
- "fetching only the first certain number of nodes"
3862
- limit: Int,
3863
- "fetching only nodes after this node (inclusive)"
3864
- offset: Int
3865
- ): JCRPropertyConnection!
3866
- "Get render URL."
3867
- renderUrl(
3868
- "Finds displayable node"
3869
- findDisplayable: Boolean = false,
3870
- "The language content is rendered in"
3871
- language: String!,
3872
- "The target workspace"
3873
- workspace: Workspace!
3874
- ): String
3875
- "Gets the fully rendered content for this node"
3876
- renderedContent(
3877
- "Rendering context configuration"
3878
- contextConfiguration: String,
3879
- "Is edit mode"
3880
- isEditMode: Boolean,
3881
- "Language"
3882
- language: String,
3883
- "Main resource path"
3884
- mainResourcePath: String,
3885
- "Additional request attributes"
3886
- requestAttributes: [InputRenderRequestAttributeInput],
3887
- "Template type"
3888
- templateType: String,
3889
- "Name of the view (leave null for default)"
3890
- view: String
3891
- ): RenderedNode
3892
- "GraphQL representation of the site the JCR node belongs to, or the system site in case the node does not belong to any site"
3893
- site: JCRSite
3894
- "The node targeted by this vanity URL"
3895
- targetNode: JCRNode
3896
- "Get node thumbnail URL"
3897
- thumbnailUrl(
3898
- "Optional: Checks if requested thumbnail node exists, returns null if it doesn't"
3899
- checkIfExists: Boolean = false,
3900
- "Thumbnail name"
3901
- name: String
3902
- ): String
3903
- "Returns languages of available translations for this node"
3904
- translationLanguages(
3905
- "Optional: Return languages only if it is active for the site"
3906
- isActiveOnly: Boolean
3907
- ): [String]
3908
- "The vanity URL"
3909
- url: String
3910
- "GraphQL representations of the reference properties that target the current JCR Node"
3911
- usages(
3912
- "fetching only nodes after this node (exclusive)"
3913
- after: String,
3914
- "fetching only nodes before this node (exclusive)"
3915
- before: String,
3916
- "Filter by graphQL fields values"
3917
- fieldFilter: InputFieldFiltersInput,
3918
- "Sort by graphQL fields values"
3919
- fieldSorter: InputFieldSorterInput,
3920
- "fetching only the first certain number of nodes"
3921
- first: Int,
3922
- "fetching only the last certain number of nodes"
3923
- last: Int,
3924
- "fetching only the first certain number of nodes"
3925
- limit: Int,
3926
- "fetching only nodes after this node (inclusive)"
3927
- offset: Int
3928
- ): UsageConnection!
3929
- "The UUID of the JCR node this object represents"
3930
- uuid: String!
3931
- "Get vanity URLs from the current node filtered by the parameters"
3932
- vanityUrls(
3933
- "Filter results based on graphql field values"
3934
- fieldFilter: InputFieldFiltersInput,
3935
- "Languages"
3936
- languages: [String]
3937
- ): [VanityUrl]
3938
- "Read work in progress information for a given node"
3939
- wipInfo: wipInfo
3940
- "Get the workspace of the query"
3941
- workspace: Workspace!
3942
- }
3943
-
3944
- type VanityUrlMappingMutation {
3945
- "Deletes the current vanity url"
3946
- delete: Boolean
3947
- "Move the vanity URL to another node"
3948
- move(
3949
- "The path of the target node"
3950
- target: String!
3951
- ): Boolean
3952
- "Get mutation on underlying node"
3953
- nodeMutation: JCRNodeMutation
3954
- "Update vanity URL"
3955
- update(
3956
- "Desired value of the active flag or null to keep existing value"
3957
- active: Boolean,
3958
- "Desired value of the default flag or null to keep existing value"
3959
- defaultMapping: Boolean,
3960
- "Desired vanity URL language or null to keep existing value"
3961
- language: String,
3962
- "Desired URL value or null to keep existing value"
3963
- url: String
3964
- ): Boolean
3965
- "Get the identifier of the node currently being mutated"
3966
- uuid: String
3967
- }
3968
-
3969
- "Workflow process"
3970
- type Workflow {
3971
- "Workflow creation time"
3972
- creationTime: String
3973
- "Workflow due date"
3974
- dueDate: String
3975
- "Username who started the workflow"
3976
- startUser: String
3977
- }
3978
-
3979
- type WorkflowMutation {
3980
- abortWorkflow: Boolean
3981
- workflow: Workflow
3982
- }
3983
-
3984
- "Workflow service"
3985
- type WorkflowService {
3986
- "Retrieves the number of active workflow tasks for the current user"
3987
- activeWorkflowTaskCountForUser: Int
3988
- "Retrieves the active workflow tasks for the current user"
3989
- activeWorkflowTasksForUser(
3990
- "fetching only nodes after this node (exclusive)"
3991
- after: String,
3992
- "fetching only nodes before this node (exclusive)"
3993
- before: String,
3994
- "fetching only the first certain number of nodes"
3995
- first: Int,
3996
- "fetching only the last certain number of nodes"
3997
- last: Int,
3998
- "fetching only the first certain number of nodes"
3999
- limit: Int,
4000
- "fetching only nodes after this node (inclusive)"
4001
- offset: Int
4002
- ): TaskConnection
4003
- }
4004
-
4005
- type ZipFileMutation {
4006
- "zip a file"
4007
- addToZip(
4008
- "list of paths or ids to zip"
4009
- pathsOrIds: [String]!
4010
- ): Boolean
4011
- "unzip a zip file"
4012
- unzip(
4013
- "destination path to unzip"
4014
- path: String!
4015
- ): Boolean
4016
- }
4017
-
4018
- "Task that prevents server from shutdown"
4019
- type task {
4020
- "The name of the task associated with the service"
4021
- name: String
4022
- "Service attached to the task being monitored"
4023
- service: String
4024
- "Datetime at which the task was started or registered"
4025
- started: String
4026
- }
4027
-
4028
- "Work in progress information"
4029
- type wipInfo {
4030
- "The languages set for Work in progress"
4031
- languages: [String]
4032
- "Get WIP status"
4033
- status: WipStatus
4034
- }
4035
-
4036
- enum FieldEvaluation {
4037
- "The property value is among given Strings"
4038
- AMONG
4039
- "The property value contains given String "
4040
- CONTAINS
4041
- "The property value contains given String ignoring the case"
4042
- CONTAINS_IGNORE_CASE
4043
- "The field value is different from given one"
4044
- DIFFERENT
4045
- "The field value is empty - either null value, or no items for a list"
4046
- EMPTY
4047
- "The field value is equal to given one"
4048
- EQUAL
4049
- "The field value is not empty - if a list, must contain at least one item"
4050
- NOT_EMPTY
4051
- }
4052
-
4053
- enum GqlBackgroundJobState {
4054
- "FINISHED"
4055
- FINISHED
4056
- "STARTED"
4057
- STARTED
4058
- "VETOED"
4059
- VETOED
4060
- }
4061
-
4062
- enum GqlBackgroundJobStatus {
4063
- "ADDED"
4064
- ADDED
4065
- "CANCELED"
4066
- CANCELED
4067
- "EXECUTING"
4068
- EXECUTING
4069
- "FAILED"
4070
- FAILED
4071
- "SCHEDULED"
4072
- SCHEDULED
4073
- "SUCCESSFUL"
4074
- SUCCESSFUL
4075
- }
4076
-
4077
- "Available health statuses for a probe"
4078
- enum GqlProbeHealth {
4079
- "GREEN"
4080
- GREEN
4081
- "RED"
4082
- RED
4083
- "YELLOW"
4084
- YELLOW
4085
- }
4086
-
4087
- "Available severity levels for SAM probes"
4088
- enum GqlProbeSeverity {
4089
- "CRITICAL"
4090
- CRITICAL
4091
- "DEBUG"
4092
- DEBUG
4093
- "HIGH"
4094
- HIGH
4095
- "LOW"
4096
- LOW
4097
- "MEDIUM"
4098
- MEDIUM
4099
- }
4100
-
4101
- enum GroupingType {
4102
- "Put grouped items at the end in the order groups appear in the 'groups' list"
4103
- END
4104
- "Put grouped items at the start in the order groups appear in the 'groups' list"
4105
- START
4106
- }
4107
-
4108
- enum JCRPropertyOption {
4109
- "ENCRYPTED"
4110
- ENCRYPTED
4111
- "NOT_ZONED_DATE"
4112
- NOT_ZONED_DATE
4113
- }
4114
-
4115
- enum JCRPropertyType {
4116
- "BINARY"
4117
- BINARY
4118
- "BOOLEAN"
4119
- BOOLEAN
4120
- "DATE"
4121
- DATE
4122
- "DECIMAL"
4123
- DECIMAL
4124
- "DOUBLE"
4125
- DOUBLE
4126
- "LONG"
4127
- LONG
4128
- "NAME"
4129
- NAME
4130
- "PATH"
4131
- PATH
4132
- "REFERENCE"
4133
- REFERENCE
4134
- "STRING"
4135
- STRING
4136
- "UNDEFINED"
4137
- UNDEFINED
4138
- "URI"
4139
- URI
4140
- "WEAKREFERENCE"
4141
- WEAKREFERENCE
4142
- }
4143
-
4144
- "Interval expressed in minutes"
4145
- enum LoadInterval {
4146
- "FIFTEEN"
4147
- FIFTEEN
4148
- "FIVE"
4149
- FIVE
4150
- "ONE"
4151
- ONE
4152
- }
4153
-
4154
- enum MulticriteriaEvaluation {
4155
- "The result criteria evaluates positive if all sub-criteria evaluate positive"
4156
- ALL
4157
- "The result criteria evaluates positive if any sub-criteria evaluates positive"
4158
- ANY
4159
- "The result criteria evaluates positive if no sub-criteria evaluates positive"
4160
- NONE
4161
- }
4162
-
4163
- enum NodeNamingConflictResolutionStrategy {
4164
- "FAIL"
4165
- FAIL
4166
- "RENAME"
4167
- RENAME
4168
- }
4169
-
4170
- enum OrderType {
4171
- "Ascendant order"
4172
- ASC
4173
- "Descendant order"
4174
- DESC
4175
- }
4176
-
4177
- enum PasteMode {
4178
- "COPY"
4179
- COPY
4180
- "MOVE"
4181
- MOVE
4182
- }
4183
-
4184
- enum PathType {
4185
- "The specified path is an ancestor, so all its descendants will be considered in the query"
4186
- ANCESTOR
4187
- "The specified path is a node itself, so only this node will be considered in the query"
4188
- OWN
4189
- "The specified path is a parent, so all its direct children will be considered in the query"
4190
- PARENT
4191
- }
4192
-
4193
- "Principal type"
4194
- enum PrincipalType {
4195
- "Group principal type"
4196
- GROUP
4197
- "User principal type"
4198
- USER
4199
- }
4200
-
4201
- enum PropertyEvaluation {
4202
- "The property is absent"
4203
- ABSENT
4204
- "The property value is different from given one"
4205
- DIFFERENT
4206
- "The property value is equal to given one"
4207
- EQUAL
4208
- "The property is present"
4209
- PRESENT
4210
- }
4211
-
4212
- enum PublicationStatus {
4213
- "CONFLICT"
4214
- CONFLICT
4215
- "DELETED"
4216
- DELETED
4217
- "LIVE_MODIFIED"
4218
- LIVE_MODIFIED
4219
- "LIVE_ONLY"
4220
- LIVE_ONLY
4221
- "MANDATORY_LANGUAGE_UNPUBLISHABLE"
4222
- MANDATORY_LANGUAGE_UNPUBLISHABLE
4223
- "MANDATORY_LANGUAGE_VALID"
4224
- MANDATORY_LANGUAGE_VALID
4225
- "MARKED_FOR_DELETION"
4226
- MARKED_FOR_DELETION
4227
- "MODIFIED"
4228
- MODIFIED
4229
- "NOT_PUBLISHED"
4230
- NOT_PUBLISHED
4231
- "PUBLISHED"
4232
- PUBLISHED
4233
- "UNPUBLISHED"
4234
- UNPUBLISHED
4235
- }
4236
-
4237
- enum QueryFunction {
4238
- "Query function for lower case comparison"
4239
- LOWER_CASE
4240
- "Query function for node local name comparison"
4241
- NODE_LOCAL_NAME
4242
- "Query function for node name comparison"
4243
- NODE_NAME
4244
- "Query function for upper case comparison"
4245
- UPPER_CASE
4246
- }
4247
-
4248
- "JCR query languages available to use for nodes querying"
4249
- enum QueryLanguage {
4250
- "SQL2 query language"
4251
- SQL2
4252
- "XPath query language"
4253
- XPATH
4254
- }
4255
-
4256
- "The target position of reordered child nodes"
4257
- enum ReorderedChildrenPosition {
4258
- "Specified children are sorted in a requested order and placed at the top, before all remaining children"
4259
- FIRST
4260
- "Specified children are sorted in a requested order, but remaining are kept at their places"
4261
- INPLACE
4262
- "Specified children are sorted in a requested order and placed at the end of the list after the remaining children"
4263
- LAST
4264
- }
4265
-
4266
- enum SortType {
4267
- "Ascendant order"
4268
- ASC
4269
- "Descendant order"
4270
- DESC
4271
- }
4272
-
4273
- "State of the publication event"
4274
- enum State {
4275
- "FINISHED"
4276
- FINISHED
4277
- "STARTED"
4278
- STARTED
4279
- "UNPUBLISHED"
4280
- UNPUBLISHED
4281
- }
4282
-
4283
- "The target scheduler(s)"
4284
- enum TargetScheduler {
4285
- "Both persisted and RAM schedulers will be used"
4286
- BOTH
4287
- "RAM scheduler will be used"
4288
- RAM_SCHEDULER
4289
- "Persisted scheduler will be used"
4290
- SCHEDULER
4291
- }
4292
-
4293
- enum TokenState {
4294
- "ACTIVE"
4295
- ACTIVE
4296
- "DISABLED"
4297
- DISABLED
4298
- }
4299
-
4300
- enum WipStatus {
4301
- "Work in progress for all languages"
4302
- ALL_CONTENT
4303
- "Work in progress disabled"
4304
- DISABLED
4305
- "Work in progress for specified languages"
4306
- LANGUAGES
4307
- }
4308
-
4309
- "JCR workspace to use for the operations"
4310
- enum Workspace {
4311
- "Edit workspace"
4312
- EDIT
4313
- "Live workspace"
4314
- LIVE
4315
- }
4316
-
4317
- "Date type"
4318
- scalar Date
4319
-
4320
- "A 64-bit signed integer"
4321
- scalar Long
4322
-
4323
- "Info about a node to be reproduced at (moved or copied to) another parent node"
4324
- input InputCarriedJCRNode {
4325
- "The name of the node at the new location or null if its current name should be preserved"
4326
- destName: String
4327
- "Path or UUID of the destination parent node to copy/move the node to"
4328
- destParentPathOrId: String!
4329
- "Path or UUID of the node to be copied/moved"
4330
- pathOrId: String!
4331
- }
4332
-
4333
- input InputContextEntryInput {
4334
- key: String
4335
- value: [String]
4336
- }
4337
-
4338
- "Input object representing either a sub-filter (so that nested conditional logic can be composed), or a condition to filter by a single field"
4339
- input InputFieldFilterInput {
4340
- "The way to evaluate the property; null indicates default (EQUAL)"
4341
- evaluation: FieldEvaluation
4342
- "Either a non-null sub-filter, or null in case the input object represents a simple field filter configured via its other properties"
4343
- fieldFilter: InputFieldFiltersInput
4344
- "The name of the field or its alias to filter by"
4345
- fieldName: String
4346
- "The value to evaluate the field against (for single-valued operations)"
4347
- value: String
4348
- "The values to evaluate the field against (for multi-valued operations)"
4349
- values: [String]
4350
- }
4351
-
4352
- "Filter any GraphQL node based on a sub-fields values"
4353
- input InputFieldFiltersInput {
4354
- "Individual property filters"
4355
- filters: [InputFieldFilterInput]!
4356
- "The way to combine multiple individual property filters; null indicates default (ALL)"
4357
- multi: MulticriteriaEvaluation
4358
- }
4359
-
4360
- "Group entries according to criteria"
4361
- input InputFieldGroupingInput {
4362
- "fieldName to group on"
4363
- fieldName: String!
4364
- "grouping type"
4365
- groupingType: GroupingType!
4366
- "specified groups"
4367
- groups: [String]!
4368
- }
4369
-
4370
- "object with fieldName and sort direction (ASC/DESC)"
4371
- input InputFieldSorterInput {
4372
- "fieldName to sort"
4373
- fieldName: String
4374
- "ignore case when sorting"
4375
- ignoreCase: Boolean
4376
- "direction of the sort"
4377
- sortType: SortType
4378
- }
4379
-
4380
- "An optional part of the JCR node criteria to filter nodes, specifically by their arbitrary properties"
4381
- input InputGqlJcrNodeConstraintInput {
4382
- "A list of child constraint input for all composition"
4383
- all: [InputGqlJcrNodeConstraintInput]
4384
- "A list of child constraint input for any composition"
4385
- any: [InputGqlJcrNodeConstraintInput]
4386
- "A search expression to match the node property value(s) against, either specific property only or all node properties, dependent on the 'property' parameter value passed"
4387
- contains: String
4388
- "A value to compare the node property value to, using the 'equals to' operator"
4389
- equals: String
4390
- "A value to compare the node property value to, using the 'exists' operator"
4391
- exists: Boolean
4392
- "The query function name for the node for comparison"
4393
- function: QueryFunction
4394
- "A value to compare the node property value to, using the 'greater than' operator"
4395
- gt: String
4396
- "A value to compare the node property value to, using the 'greater than or equals to' operator"
4397
- gte: String
4398
- "A value to pick the last days for node property date value, using the 'lastDays' operator"
4399
- lastDays: Int
4400
- "A value to compare the node property value to, using the 'like' operator"
4401
- like: String
4402
- "A value to compare the node property value to, using the 'less than' operator"
4403
- lt: String
4404
- "A value to compare the node property value to, using the 'less than or equals to' operator"
4405
- lte: String
4406
- "A list of child constraint input for none composition"
4407
- none: [InputGqlJcrNodeConstraintInput]
4408
- "A value to compare the node property value to, using the 'not equals to' operator"
4409
- notEquals: String
4410
- "The name of the node property to compare/match; may be null when optional or not applicable, dependent on other parameter values"
4411
- property: String
4412
- }
4413
-
4414
- "Node criterias"
4415
- input InputGqlJcrNodeCriteriaInput {
4416
- "Language to access node properties in"
4417
- language: String
4418
- "Additional constraint to filter nodes by their arbitrary properties"
4419
- nodeConstraint: InputGqlJcrNodeConstraintInput
4420
- "The type of nodes to query"
4421
- nodeType: String!
4422
- "Ordering strategies"
4423
- ordering: InputGqlOrdering
4424
- "The exact meaning of the paths field"
4425
- pathType: PathType
4426
- "Paths that restrict areas to fetch nodes from; the exact meaning is defined by the pathType field; null or empty collection means no path restrictions"
4427
- paths: [String]
4428
- }
4429
-
4430
- "Ordering"
4431
- input InputGqlOrdering {
4432
- "ASC or DESC order"
4433
- orderType: OrderType
4434
- "The property to order by"
4435
- property: String
4436
- }
4437
-
4438
- "GraphQL representation of a JCR node to be created"
4439
- input InputJCRNode {
4440
- "The collection of sub nodes to create"
4441
- children: [InputJCRNode]
4442
- "The collection of mixins to add to the node"
4443
- mixins: [String]
4444
- "The name of the node to create"
4445
- name: String!
4446
- "The primary node type of the node to create"
4447
- primaryNodeType: String!
4448
- "The collection of properties to set to the node"
4449
- properties: [InputJCRProperty]
4450
- "If true, use the next available name for a node, appending if needed numbers. Default is false"
4451
- useAvailableNodeName: Boolean
4452
- }
4453
-
4454
- "GraphQL representation of a JCR node to be created"
4455
- input InputJCRNodeWithParent {
4456
- "The collection of sub nodes to create"
4457
- children: [InputJCRNode]
4458
- "The collection of mixins to add to the node"
4459
- mixins: [String]
4460
- "The name of the node to create"
4461
- name: String!
4462
- "The parent path or id where the node will be created"
4463
- parentPathOrId: String!
4464
- "The primary node type of the node to create"
4465
- primaryNodeType: String!
4466
- "The collection of properties to set to the node"
4467
- properties: [InputJCRProperty]
4468
- "If true, use the next available name for a node, appending if needed numbers. Default is false"
4469
- useAvailableNodeName: Boolean
4470
- }
4471
-
4472
- "GraphQL representation of a JCR property to set"
4473
- input InputJCRProperty {
4474
- "The language in which the property will be set (for internationalized properties"
4475
- language: String
4476
- "The name of the property to set"
4477
- name: String!
4478
- "The option of the property"
4479
- option: JCRPropertyOption
4480
- "The type of the property"
4481
- type: JCRPropertyType
4482
- "The value to set (for single valued properties)"
4483
- value: String
4484
- "The values to set (for multivalued properties)"
4485
- values: [String]
4486
- }
4487
-
4488
- "Node properties selection"
4489
- input InputNodePropertiesInput {
4490
- "Individual property filters"
4491
- filters: [InputNodePropertyInput]!
4492
- "The way to combine multiple individual property filters; null indicates default (ALL)"
4493
- multi: MulticriteriaEvaluation
4494
- }
4495
-
4496
- "Node property selection"
4497
- input InputNodePropertyInput {
4498
- "The way to evaluate the property; null indicates default (EQUAL)"
4499
- evaluation: PropertyEvaluation
4500
- "Language to use when evaluating the property"
4501
- language: String
4502
- "The name of the property to filter by"
4503
- property: String!
4504
- "The value to evaluate the property against"
4505
- value: String
4506
- }
4507
-
4508
- "Node types selection"
4509
- input InputNodeTypesInput {
4510
- "The way to combine multiple type criteria; null indicates default (ANY)"
4511
- multi: MulticriteriaEvaluation
4512
- "Node type names required for a node to pass the filter"
4513
- types: [String]!
4514
- }
4515
-
4516
- "Input for nodetypes list"
4517
- input InputNodeTypesListInput {
4518
- "Consider sub-types when checking for included/excluded nodetypes (default true)"
4519
- considerSubTypes: Boolean
4520
- "Exclude the types, specified by this list (also considering sub-types, if considerSubTypes is true)"
4521
- excludeTypes: [String]
4522
- "Include abstract types (default true)"
4523
- includeAbstract: Boolean
4524
- "Include mixin types (default true)"
4525
- includeMixins: Boolean
4526
- "Include non mixin types (default true)"
4527
- includeNonMixins: Boolean
4528
- "Only include types specified by this list (also considering sub-types, if considerSubTypes is true)"
4529
- includeTypes: [String]
4530
- "Filter on nodetypes defined in these modules"
4531
- modules: [String]
4532
- "Consider only nodetypes for the specified site"
4533
- siteKey: String
4534
- }
4535
-
4536
- "Describes input using name and with principal type (user/group)"
4537
- input InputPrincipalInput {
4538
- "Get principal name"
4539
- name: String
4540
- "Get principal type (user/group)"
4541
- type: PrincipalType
4542
- }
4543
-
4544
- "Request attribute that can be use by rendering API"
4545
- input InputRenderRequestAttributeInput {
4546
- "The name of the request attribute"
4547
- name: String!
4548
- "The value of the request attribute"
4549
- value: String!
4550
- }
4551
-
4552
- input InputVanityUrl {
4553
- "true if the URL mapping is activated or false if it is not activated"
4554
- active: Boolean
4555
- "true whether this URL mapping is the default one for the language"
4556
- defaultMapping: Boolean!
4557
- "The language of the content object to which the vanity URL maps to"
4558
- language: String!
4559
- "The vanity URL"
4560
- url: String!
4561
- }
4562
-
4563
- "Work in progress information"
4564
- input InputwipInfo {
4565
- "The languages set for Work in progress"
4566
- languages: [String]
4567
- "Get WIP status"
4568
- status: WipStatus
4569
- }