/
AtlassianConfluenceCloud.yml
1925 lines (1881 loc) · 87 KB
/
AtlassianConfluenceCloud.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
category: Utilities
commonfields:
id: Atlassian Confluence Cloud
version: -1
configuration:
- additionalinfo: Site name of the Confluence cloud the user wants to connect to.
display: Site Name (e.g., https://${site-name}.atlassian.net)
name: url
required: true
type: 0
- additionalinfo: The Atlassian account email.
display: Email
displaypassword: API Token
name: username
required: true
type: 9
- display: Use system proxy settings
name: proxy
type: 8
required: false
- display: Trust any certificate (not secure)
name: insecure
type: 8
required: false
description: Atlassian Confluence Cloud allows users to interact with confluence entities like content, space, users, and groups. Users can also manage the space permissions.
display: Atlassian Confluence Cloud
name: Atlassian Confluence Cloud
script:
commands:
- arguments:
- description: |-
The key for the new space. It can contain any alphanumeric character (a-z, 0-9). The maximum length is 255 characters.
Note: unique_key cannot be changed after the space is created.
name: unique_key
required: true
- description: The name of the new space. The maximum length is 200 characters.
name: name
required: true
- description: The description of the new space.
name: description
- auto: PREDEFINED
defaultValue: 'false'
description: |-
Whether the user wants to create a private space.
Note: If this option is set to true, permission cannot be applied.
name: is_private_space
predefined:
- 'true'
- 'false'
- description: |-
The account ID of the user to whom permission should be granted.
Note: To retrieve the account ID, execute the confluence-cloud-user-list command.
name: permission_account_id
- description: |-
The group name to whom permission should be granted.
Note: To retrieve the group name, execute the confluence-cloud-group-list command.
name: permission_group_name
- description: |-
A comma-separated list of the permissions that should be applied.
Note: Requires either permission_account_id or permission_group_name.
Format accepted: operation1:targetType1,
operation2:targetType2
For example: read:space, create:page
Possible values for operation: create, read, delete, export, administer.
Possible values for targetType: space, page, blogpost, comment, attachment.
isArray: true
name: permission_operations
- description: |-
Specify 'advanced_permissions' to grant access to multiple users or groups. 'advanced_permissions' has priority over 'permission_operations'.
Note: Add backslash(\) before quotes.
For example: [ { \"subjects\": { \"user\": { \"results\": [ { \"accountId\": \"5ff2e30b4d2179006ea18449\" } ] }, \"group\": { \"results\": [ { \"name\": \"administrators\" } ] } }, \"operation\": { \"operation\": \"read\", \"targetType\": \"space\" }, \"anonymousAccess\": false, \"unlicensedAccess\": false } ]
To prepare a valid JSON for advanced_permissions, navigate to https://developer.atlassian.com/cloud/confluence/rest/api-group-space/#api-wiki-rest-api-space-post and see the permission parameter in it.
name: advanced_permissions
description: |-
Creates a new space.
Note: If no permissions are specified, the default space permissions defined by the Confluence cloud account admin will be used.
name: confluence-cloud-space-create
outputs:
- contextPath: ConfluenceCloud.Space.id
description: ID of the space.
type: Number
- contextPath: ConfluenceCloud.Space.key
description: Key of the space.
type: String
- contextPath: ConfluenceCloud.Space.name
description: Name of the space.
type: String
- contextPath: ConfluenceCloud.Space.description.view.value
description: The description of the space in view format.
type: String
- contextPath: ConfluenceCloud.Space.description.view.representation
description: Representation format of the description in view format.
type: String
- contextPath: ConfluenceCloud.Space.description.plain.value
description: The description of the space in plain format.
type: String
- contextPath: ConfluenceCloud.Space.description.plain.representation
description: Representation format of the description in plain format.
type: String
- contextPath: ConfluenceCloud.Space.homepage.id
description: ID of the homepage of the space.
type: String
- contextPath: ConfluenceCloud.Space.homepage.type
description: Type of the homepage of the space.
type: String
- contextPath: ConfluenceCloud.Space.homepage.status
description: Status of the homepage of the space.
type: String
- contextPath: ConfluenceCloud.Space.homepage.title
description: Title of the homepage of the space.
type: String
- contextPath: ConfluenceCloud.Space.homepage.extensions.position
description: The content extension position.
type: Number
- contextPath: ConfluenceCloud.Space.homepage._links.self
description: Link to the homepage of the space.
type: String
- contextPath: ConfluenceCloud.Space.homepage._links.tinyui
description: Tiny link to the homepage of the space.
type: String
- contextPath: ConfluenceCloud.Space.homepage._links.editui
description: Edit the user interface link to the homepage of the space.
type: String
- contextPath: ConfluenceCloud.Space.homepage._links.webui
description: Web user interface link to the homepage of the space.
type: String
- contextPath: ConfluenceCloud.Space.type
description: Type of the space.
type: String
- contextPath: ConfluenceCloud.Space.permissions.id
description: ID of the space permission.
type: Number
- contextPath: ConfluenceCloud.Space.permissions.subjects.user.results.type
description: Type of the user to whom the space permission applies.
type: String
- contextPath: ConfluenceCloud.Space.permissions.subjects.user.results.accountId
description: Account ID of the user to whom the space permission applies.
type: String
- contextPath: ConfluenceCloud.Space.permissions.subjects.user.results.accountType
description: Account type of the user to whom the space permission applies.
type: String
- contextPath: ConfluenceCloud.Space.permissions.subjects.user.results.email
description: Email of the user to whom the space permission applies.
type: String
- contextPath: ConfluenceCloud.Space.permissions.subjects.user.results.publicName
description: Public name of the user to whom the space permission applies.
type: String
- contextPath: ConfluenceCloud.Space.permissions.subjects.user.results.profilePicture.path
description: Path of the user's profile picture to whom the space permission applies.
type: String
- contextPath: ConfluenceCloud.Space.permissions.subjects.user.results.profilePicture.width
description: Width in pixels of the user's profile picture to whom the space permission applies.
type: Number
- contextPath: ConfluenceCloud.Space.permissions.subjects.user.results.profilePicture.height
description: Height in pixels of the user's profile picture to whom the space permission applies.
type: Number
- contextPath: ConfluenceCloud.Space.permissions.subjects.user.results.profilePicture.isDefault
description: Whether the profile picture of the user is the default picture to whom the space permission applies.
type: Boolean
- contextPath: ConfluenceCloud.Space.permissions.subjects.user.results.displayName
description: Display name of the user to whom the space permission applies.
type: String
- contextPath: ConfluenceCloud.Space.permissions.subjects.user.results.isExternalCollaborator
description: Whether the user is an external collaborator user.
type: Boolean
- contextPath: ConfluenceCloud.Space.permissions.subjects.user.results._links.self
description: Link to the user to whom the space permission applies.
type: String
- contextPath: ConfluenceCloud.Space.permissions.subjects.user.size
description: Size of the list of users for a given space.
type: Number
- contextPath: ConfluenceCloud.Space.permissions.subjects.group.results.type
description: Type of the group to whom the space permission applies.
type: String
- contextPath: ConfluenceCloud.Space.permissions.subjects.group.results.name
description: Name of the group to whom the space permission applies.
type: String
- contextPath: ConfluenceCloud.Space.permissions.subjects.group.results.id
description: ID of the group to whom the space permission applies.
type: String
- contextPath: ConfluenceCloud.Space.permissions.subjects.group.results._links.self
description: Link to the group to whom the space permission applies.
type: String
- contextPath: ConfluenceCloud.Space.permissions.subjects.group.size
description: Size of the list of groups for the given space.
type: Number
- contextPath: ConfluenceCloud.Space.permissions.operation.operation
description: Name of the permission operation.
type: String
- contextPath: ConfluenceCloud.Space.permissions.operation.targetType
description: The space or content type that the operation applies to.
type: String
- contextPath: ConfluenceCloud.Space.permissions.anonymousAccess
description: Whether anonymous users have permission to use the operation.
type: Boolean
- contextPath: ConfluenceCloud.Space.permissions.unlicensedAccess
description: Whether unlicensed users have access from JIRA Service Desk when used with the read space operation.
type: Boolean
- contextPath: ConfluenceCloud.Space.status
description: Status of the space.
type: String
- contextPath: ConfluenceCloud.Space._links.webui
description: Web user interface link of the space.
type: String
- contextPath: ConfluenceCloud.Space._links.context
description: Context link of the space.
type: String
- contextPath: ConfluenceCloud.Space._links.self
description: Link to the space.
type: String
- contextPath: ConfluenceCloud.Space._links.collection
description: Collection link of the space.
type: String
- contextPath: ConfluenceCloud.Space._links.base
description: Base link to the space.
type: String
- arguments:
- description: |-
The title of the content.
Note: The maximum title length is 255 characters.
name: title
required: true
- auto: PREDEFINED
description: "The type of the new content. \nPossible values: page, blogpost."
name: type
predefined:
- page
- blogpost
required: true
- description: The space key that the content is being created in.
name: space_key
required: true
- auto: PREDEFINED
defaultValue: current
description: |-
The status of the new content.
Possible values: current, trashed, draft.
Note: The term 'current' refers to the content that is currently active.
name: status
predefined:
- current
- trashed
- draft
- description: |-
The body of the new content.
Note: 'body_value' must be a string. In order to reflect 'body_value', 'body_representation' is required.
name: body_value
- auto: PREDEFINED
description: |-
The content format type.
Possible values: view, export_view, styled_view, storage, editor2, anonymous_export_view.
name: body_representation
predefined:
- view
- export_view
- styled_view
- storage
- editor2
- anonymous_export_view
- description: |-
The ID of the parent content to create the child content.
Note: Supported for content type page only. To retrieve the ancestor_id, execute the confluence-cloud-content-search command using the query="type=page" argument.
name: ancestor_id
description: |-
Creates a page or blogpost for a given space.
Note: To view the expansion of content properties, execute the confluence-cloud-content-list and confluence-cloud-content-search commands.
name: confluence-cloud-content-create
outputs:
- contextPath: ConfluenceCloud.Content.id
description: The ID of the content.
type: String
- contextPath: ConfluenceCloud.Content.type
description: Type of the content.
type: String
- contextPath: ConfluenceCloud.Content.status
description: Status of the content.
type: String
- contextPath: ConfluenceCloud.Content.title
description: Title of the content.
type: String
- contextPath: ConfluenceCloud.Content.childTypes.attachment.value
description: Whether the attachment has the given content.
type: Boolean
- contextPath: ConfluenceCloud.Content.childTypes.attachment._links.self
description: Link to the attachment with the given content.
type: String
- contextPath: ConfluenceCloud.Content.childTypes.comment.value
description: Whether a comment is associated with the given content.
type: Boolean
- contextPath: ConfluenceCloud.Content.childTypes.comment._links.self
description: Link to the comment associated with the given content.
type: String
- contextPath: ConfluenceCloud.Content.childTypes.page.value
description: Whether the page is associated with the given content.
type: Boolean
- contextPath: ConfluenceCloud.Content.childTypes.page._links.self
description: Link to the page associated with the given content.
type: String
- contextPath: ConfluenceCloud.Content.space.id
description: ID of the space that the content is being created in.
type: Number
- contextPath: ConfluenceCloud.Content.space.key
description: Key of the space that the content is being created in.
type: String
- contextPath: ConfluenceCloud.Content.space.name
description: Name of the space that the content is being created in.
type: String
- contextPath: ConfluenceCloud.Content.space.type
description: Type of the space that the content is being created in.
type: String
- contextPath: ConfluenceCloud.Content.space.status
description: Status of the space that the content is being created in.
type: String
- contextPath: ConfluenceCloud.Content.space._links.webui
description: Web user interface link to the space that the content is being created in.
type: String
- contextPath: ConfluenceCloud.Content.space._links.self
description: Link to the space that the content is being created in.
type: String
- contextPath: ConfluenceCloud.Content.history.latest
description: Whether the content is the latest content.
type: Boolean
- contextPath: ConfluenceCloud.Content.history.createdBy.type
description: Type of the user who created the content.
type: String
- contextPath: ConfluenceCloud.Content.history.createdBy.accountId
description: Account ID of the user creating the content.
type: String
- contextPath: ConfluenceCloud.Content.history.createdBy.accountType
description: Account type of the user creating the content.
type: String
- contextPath: ConfluenceCloud.Content.history.createdBy.email
description: Email of the user creating the content.
type: String
- contextPath: ConfluenceCloud.Content.history.createdBy.publicName
description: Public name of the user creating the content.
type: String
- contextPath: ConfluenceCloud.Content.history.createdBy.profilePicture.path
description: Profile picture path of the user creating the content.
type: String
- contextPath: ConfluenceCloud.Content.history.createdBy.profilePicture.width
description: Width in pixels of the profile picture of the user.
type: Number
- contextPath: ConfluenceCloud.Content.history.createdBy.profilePicture.height
description: Height in pixels of the profile picture of the user.
type: Number
- contextPath: ConfluenceCloud.Content.history.createdBy.profilePicture.isDefault
description: Whether the profile picture is the default profile picture.
type: Boolean
- contextPath: ConfluenceCloud.Content.history.createdBy.displayName
description: Display name of the user who created the content.
type: String
- contextPath: ConfluenceCloud.Content.history.createdBy.isExternalCollaborator
description: Whether the user is an external collaborator.
type: Boolean
- contextPath: ConfluenceCloud.Content.history.createdBy._links.self
description: Link to the creator of the content.
type: String
- contextPath: ConfluenceCloud.Content.history.createdDate
description: Date and time, in ISO 8601 format, when the content was created.
type: Date
- contextPath: ConfluenceCloud.Content.history._links.self
description: Link to the history of the content.
type: String
- contextPath: ConfluenceCloud.Content.version.by.type
description: Type of the user who last updated the content.
type: String
- contextPath: ConfluenceCloud.Content.version.by.accountId
description: Account ID of the user who last updated the content.
type: String
- contextPath: ConfluenceCloud.Content.version.by.accountType
description: Account type of the user who last updated the content.
type: String
- contextPath: ConfluenceCloud.Content.version.by.email
description: Email of the user who last updated the content.
type: String
- contextPath: ConfluenceCloud.Content.version.by.publicName
description: Public name of the user who last updated the content.
type: String
- contextPath: ConfluenceCloud.Content.version.by.profilePicture.path
description: Profile picture of the user who last updated the content.
type: String
- contextPath: ConfluenceCloud.Content.version.by.profilePicture.width
description: Width in pixels of the profile picture of the user who last updated the content.
type: Number
- contextPath: ConfluenceCloud.Content.version.by.profilePicture.height
description: Height in pixels of the profile picture of the user who last updated the content.
type: Number
- contextPath: ConfluenceCloud.Content.version.by.profilePicture.isDefault
description: Whether the profile picture is the default profile picture.
type: Boolean
- contextPath: ConfluenceCloud.Content.version.by.displayName
description: Display name of the user who last updated the content.
type: String
- contextPath: ConfluenceCloud.Content.version.by.isExternalCollaborator
description: Whether the user is an external collaborator.
type: Boolean
- contextPath: ConfluenceCloud.Content.version.by._links.self
description: Link to the user who last updated the content.
type: String
- contextPath: ConfluenceCloud.Content.version.when
description: Date and time, in ISO 8601 format, when the content was updated.
type: Date
- contextPath: ConfluenceCloud.Content.version.friendlyWhen
description: Displays when the content was created.
type: String
- contextPath: ConfluenceCloud.Content.version.message
description: Message of the updated content.
type: String
- contextPath: ConfluenceCloud.Content.version.number
description: Version number of the updated content.
type: Number
- contextPath: ConfluenceCloud.Content.version.minorEdit
description: Whether the edit was minor.
type: Boolean
- contextPath: ConfluenceCloud.Content.version.confRev
description: The revision ID provided by Confluence to be used as a revision in Synchrony.
type: String
- contextPath: ConfluenceCloud.Content.version.contentTypeModified
description: True if the content type is modified in the version. (e.g., page to blog).
type: Boolean
- contextPath: ConfluenceCloud.Content.version._links.self
description: Link to the new version of the content.
type: String
- contextPath: ConfluenceCloud.Content.ancestors.id
description: ID of the parent page of the content.
type: String
- contextPath: ConfluenceCloud.Content.ancestors.type
description: Type of the parent page of the content.
type: String
- contextPath: ConfluenceCloud.Content.ancestors.status
description: Status of the parent page of the content.
type: String
- contextPath: ConfluenceCloud.Content.ancestors.title
description: Title of the parent page of the content.
type: String
- contextPath: ConfluenceCloud.Content.ancestors.extensions.position
description: The content extension position.
type: Number
- contextPath: ConfluenceCloud.Content.ancestors._links.self
description: Link to the parent page of the content.
type: String
- contextPath: ConfluenceCloud.Content.ancestors._links.tinyui
description: Tiny link to the parent page of the content.
type: String
- contextPath: ConfluenceCloud.Content.ancestors._links.editui
description: Edit user interface link to the parent page of the content.
type: String
- contextPath: ConfluenceCloud.Content.ancestors._links.webui
description: Web user interface link to the parent page of the content.
type: String
- contextPath: ConfluenceCloud.Content.container.id
description: ID of the container of the content.
type: Number
- contextPath: ConfluenceCloud.Content.container.key
description: Key of the container of the content.
type: String
- contextPath: ConfluenceCloud.Content.container.name
description: Name of the container of the content.
type: String
- contextPath: ConfluenceCloud.Content.container.type
description: Type of the container of the content.
type: String
- contextPath: ConfluenceCloud.Content.container.status
description: Status of the container of the content.
type: String
- contextPath: ConfluenceCloud.Content.container._links.webui
description: Web user interface link to the container of the content.
type: String
- contextPath: ConfluenceCloud.Content.container._links.self
description: Link to the container of the content.
type: String
- contextPath: ConfluenceCloud.Content.body.storage.value
description: The body of the new content.
type: String
- contextPath: ConfluenceCloud.Content.body.storage.representation
description: Representation format of the content.
type: String
- contextPath: ConfluenceCloud.Content.extensions.position
description: The content extension position.
type: Number
- contextPath: ConfluenceCloud.Content._links.editui
description: Edit user interface link of the content.
type: String
- contextPath: ConfluenceCloud.Content._links.webui
description: Web user interface link of the content.
type: String
- contextPath: ConfluenceCloud.Content._links.context
description: Context link of the content.
type: String
- contextPath: ConfluenceCloud.Content._links.self
description: Link to the content.
type: String
- contextPath: ConfluenceCloud.Content._links.tinyui
description: Tiny link of the content.
type: String
- contextPath: ConfluenceCloud.Content._links.collection
description: Collection link of the content.
type: String
- contextPath: ConfluenceCloud.Content._links.base
description: Base link to the content.
type: String
- arguments:
- auto: PREDEFINED
defaultValue: current
description: |-
The status of the new content.
Possible values: current, trashed, draft.
Note: The term 'current' refers to the comment that is currently active.
name: status
predefined:
- current
- trashed
- draft
- description: |-
The body of the new content.
Note: 'body_value' must be a string.
name: body_value
required: true
- auto: PREDEFINED
description: |-
The content format type.
Possible values: storage, editor2, editor.
name: body_representation
predefined:
- storage
- editor2
- editor
required: true
- description: |-
The ID of the parent comment for which to create the child comment.
Note: To retrieve the ancestor_id, execute the confluence-cloud-content-search command using the query="type=comment" argument.
name: ancestor_id
- description: |-
The ID of the container for which to create a comment.
Note: To retrieve the container_id, execute the confluence-cloud-content-list command.
name: container_id
required: true
- auto: PREDEFINED
description: |-
The type of the container.
Possible values: page, blogpost.
name: container_type
predefined:
- page
- blogpost
description: |-
Creates a comment for the given content.
Note: To view the expansion of the content properties, execute the confluence-cloud-content-list and confluence-cloud-content-search commands.
name: confluence-cloud-comment-create
outputs:
- contextPath: ConfluenceCloud.Comment.id
description: The ID of the comment.
type: String
- contextPath: ConfluenceCloud.Comment.type
description: Type of the comment.
type: String
- contextPath: ConfluenceCloud.Comment.status
description: Status of the comment.
type: String
- contextPath: ConfluenceCloud.Comment.title
description: Title of the comment.
type: String
- contextPath: ConfluenceCloud.Comment.childTypes.attachment.value
description: Whether the attachment has the given comment.
type: Boolean
- contextPath: ConfluenceCloud.Comment.childTypes.attachment._links.self
description: Link to the attachment with the given comment.
type: String
- contextPath: ConfluenceCloud.Comment.childTypes.comment.value
description: Whether a comment is associated with the given comment.
type: Boolean
- contextPath: ConfluenceCloud.Comment.childTypes.comment._links.self
description: Link to the comment associated with the given comment.
type: String
- contextPath: ConfluenceCloud.Comment.childTypes.page.value
description: Whether the page is associated with the given comment.
type: Boolean
- contextPath: ConfluenceCloud.Comment.childTypes.page._links.self
description: Link to the page associated with the given comment.
type: String
- contextPath: ConfluenceCloud.Comment.space.id
description: ID of the space that the comment is being created in.
type: Number
- contextPath: ConfluenceCloud.Comment.space.key
description: Key of the space that the comment is being created in.
type: String
- contextPath: ConfluenceCloud.Comment.space.name
description: Name of the space that the comment is being created in.
type: String
- contextPath: ConfluenceCloud.Comment.space.type
description: Type of the space that the comment is being created in.
type: String
- contextPath: ConfluenceCloud.Comment.space.status
description: Status of the space that the comment is being created in.
type: String
- contextPath: ConfluenceCloud.Comment.space._links.webui
description: Web user interface link to the space that the comment is being created in.
type: String
- contextPath: ConfluenceCloud.Comment.space._links.self
description: Link to the space that the comment is being created in.
type: String
- contextPath: ConfluenceCloud.Comment.history.latest
description: Whether the comment is latest.
type: Boolean
- contextPath: ConfluenceCloud.Comment.history.createdBy.type
description: Type of the user who created the comment.
type: String
- contextPath: ConfluenceCloud.Comment.history.createdBy.accountId
description: Account ID of the user creating the comment.
type: String
- contextPath: ConfluenceCloud.Comment.history.createdBy.accountType
description: Account type of the user creating the comment.
type: String
- contextPath: ConfluenceCloud.Comment.history.createdBy.email
description: Email of the user creating the comment.
type: String
- contextPath: ConfluenceCloud.Comment.history.createdBy.publicName
description: Public name of the user creating the comment.
type: String
- contextPath: ConfluenceCloud.Comment.history.createdBy.profilePicture.path
description: Profile picture path of the user creating the comment.
type: String
- contextPath: ConfluenceCloud.Comment.history.createdBy.profilePicture.width
description: Width in pixels of the profile picture of the user.
type: Number
- contextPath: ConfluenceCloud.Comment.history.createdBy.profilePicture.height
description: Height in pixels of the profile picture of the user.
type: Number
- contextPath: ConfluenceCloud.Comment.history.createdBy.profilePicture.isDefault
description: Whether the profile picture is the default profile picture.
type: Boolean
- contextPath: ConfluenceCloud.Comment.history.createdBy.displayName
description: Display name of the user who created the comment.
type: String
- contextPath: ConfluenceCloud.Comment.history.createdBy.isExternalCollaborator
description: Whether the user is an external collaborator.
type: Boolean
- contextPath: ConfluenceCloud.Comment.history.createdBy._links.self
description: Link to the creator of the comment.
type: String
- contextPath: ConfluenceCloud.Comment.history.createdDate
description: Date and time, in ISO 8601 format, when the comment was created.
type: Date
- contextPath: ConfluenceCloud.Comment.history._links.self
description: Link to the history of the comment.
type: String
- contextPath: ConfluenceCloud.Comment.version.by.type
description: Type of the user who last updated the comment.
type: String
- contextPath: ConfluenceCloud.Comment.version.by.accountId
description: Account ID of the user who last updated the comment.
type: String
- contextPath: ConfluenceCloud.Comment.version.by.accountType
description: Account type of the user who last updated the comment.
type: String
- contextPath: ConfluenceCloud.Comment.version.by.email
description: Email of the user who last updated the comment.
type: String
- contextPath: ConfluenceCloud.Comment.version.by.publicName
description: Public name of the user who last updated the comment.
type: String
- contextPath: ConfluenceCloud.Comment.version.by.profilePicture.path
description: Profile picture of the user who last updated the comment.
type: String
- contextPath: ConfluenceCloud.Comment.version.by.profilePicture.width
description: Width in pixels of the profile picture of the user who last updated the comment.
type: Number
- contextPath: ConfluenceCloud.Comment.version.by.profilePicture.height
description: Height in pixels of the profile picture of the user who last updated the comment.
type: Number
- contextPath: ConfluenceCloud.Comment.version.by.profilePicture.isDefault
description: Whether the profile picture is the default profile picture.
type: Boolean
- contextPath: ConfluenceCloud.Comment.version.by.displayName
description: Display name of the user who last updated the comment.
type: String
- contextPath: ConfluenceCloud.Comment.version.by.isExternalCollaborator
description: Whether the user is an external collaborator.
type: Boolean
- contextPath: ConfluenceCloud.Comment.version.by._links.self
description: Link to the user who last updated the comment.
type: String
- contextPath: ConfluenceCloud.Comment.version.when
description: Date and time, in ISO 8601 format, when the comment was updated.
type: Date
- contextPath: ConfluenceCloud.Comment.version.friendlyWhen
description: Displays when the content was created.
type: String
- contextPath: ConfluenceCloud.Comment.version.message
description: Message of the updated comment.
type: String
- contextPath: ConfluenceCloud.Comment.version.number
description: Version number of the updated comment.
type: Number
- contextPath: ConfluenceCloud.Comment.version.minorEdit
description: Whether the edit was minor.
type: Boolean
- contextPath: ConfluenceCloud.Comment.version.confRev
description: The revision ID provided by Confluence to be used as a revision in Synchrony.
type: String
- contextPath: ConfluenceCloud.Comment.version.contentTypeModified
description: True if the comment type is modified in the version. (e.g., page to blog).
type: Boolean
- contextPath: ConfluenceCloud.Comment.version._links.self
description: Link to the new version of the comment.
type: String
- contextPath: ConfluenceCloud.Comment.ancestors.id
description: ID of the parent page of the comment.
type: String
- contextPath: ConfluenceCloud.Comment.ancestors.type
description: Type of the parent page of the comment.
type: String
- contextPath: ConfluenceCloud.Comment.ancestors.status
description: Status of the parent page of the comment.
type: String
- contextPath: ConfluenceCloud.Comment.ancestors.title
description: Title of the parent page of the comment.
type: String
- contextPath: ConfluenceCloud.Comment.ancestors.extensions.location
description: Location of the comment.
type: String
- contextPath: ConfluenceCloud.Comment.ancestors._links.self
description: Link to the parent page of the comment.
type: String
- contextPath: ConfluenceCloud.Comment.ancestors._links.tinyui
description: Tiny link to the parent page of the comment.
type: String
- contextPath: ConfluenceCloud.Comment.ancestors._links.editui
description: Edit user interface link to the parent page of the comment.
type: String
- contextPath: ConfluenceCloud.Comment.ancestors._links.webui
description: Web user interface link to the parent page of the comment.
type: String
- contextPath: ConfluenceCloud.Comment.container.id
description: ID of the container of the comment.
type: Number
- contextPath: ConfluenceCloud.Comment.container.key
description: Key of the container of the comment.
type: String
- contextPath: ConfluenceCloud.Comment.container.name
description: Name of the container of the comment.
type: String
- contextPath: ConfluenceCloud.Comment.container.type
description: Type of the container of the comment.
type: String
- contextPath: ConfluenceCloud.Comment.container.status
description: Status of the container of the comment.
type: String
- contextPath: ConfluenceCloud.Comment.container._links.webui
description: Web user interface link to the container of the comment.
type: String
- contextPath: ConfluenceCloud.Comment.container._links.self
description: Link to the container of the comment.
type: String
- contextPath: ConfluenceCloud.Comment.body.storage.value
description: The body of the new comment.
type: String
- contextPath: ConfluenceCloud.Comment.body.storage.representation
description: Representation format of the comment.
type: String
- contextPath: ConfluenceCloud.Comment.extensions.location
description: Location of the comment.
type: String
- contextPath: ConfluenceCloud.Comment._links.editui
description: Edit user interface link of the comment.
type: String
- contextPath: ConfluenceCloud.Comment._links.webui
description: Web user interface link of the comment.
type: String
- contextPath: ConfluenceCloud.Comment._links.context
description: Context link of the comment.
type: String
- contextPath: ConfluenceCloud.Comment._links.self
description: Link to the comment.
type: String
- contextPath: ConfluenceCloud.Comment._links.tinyui
description: Tiny link of the comment.
type: String
- contextPath: ConfluenceCloud.Comment._links.collection
description: Collection link of the comment.
type: String
- contextPath: ConfluenceCloud.Comment._links.base
description: Base link to the comment.
type: String
- arguments:
- defaultValue: '50'
description: |-
Number of records to retrieve in the response.
Note: The minimum value supported is 0 and the maximum value supported is int32.
name: limit
- defaultValue: '0'
description: |-
The starting index of the returned spaces.
Note: The minimum value supported is 0 and maximum value supported is int32.
name: offset
- description: |-
A space key to retrieve the specific space.
Note: Supports a comma-separated list of values.
isArray: true
name: space_key
- description: |-
The space ID to retrieve the specific space.
Note: Supports a comma-separated list of values.
isArray: true
name: space_id
- auto: PREDEFINED
description: "Filter the results to list the spaces based on their status. \nPossible values: current, archived.\n\nNote: The term 'current' refers to the space that is currently active."
name: status
predefined:
- current
- archived
- auto: PREDEFINED
description: "Filter the results to list the spaces based on their type. \nPossible values: global, personal."
name: type
predefined:
- global
- personal
- auto: PREDEFINED
description: |-
Whether to filter the results to the favorite spaces of the current user.
Possible values: true, false.
name: favourite
predefined:
- 'true'
- 'false'
- description: "Indicates which properties to expand. \nFor reference, visit https://developer.atlassian.com/cloud/confluence/rest/api-group-space/#api-wiki-rest-api-space-get.\n\nNote: To separate multiple values, use commas. Expanded properties will be populated in context data only."
isArray: true
name: expand
description: Returns a list of all Confluence spaces.
name: confluence-cloud-space-list
outputs:
- contextPath: ConfluenceCloud.Space.id
description: ID of the space.
type: Number
- contextPath: ConfluenceCloud.Space.key
description: Key of the space.
type: String
- contextPath: ConfluenceCloud.Space.name
description: Name of the space.
type: String
- contextPath: ConfluenceCloud.Space.description.view.value
description: The description of the space in view format.
type: String
- contextPath: ConfluenceCloud.Space.description.view.representation
description: Representation format of the description in view format.
type: String
- contextPath: ConfluenceCloud.Space.description.plain.value
description: The description of the space in plain format in plain format.
type: String
- contextPath: ConfluenceCloud.Space.description.plain.representation
description: Representation format of the description in plain format.
type: String
- contextPath: ConfluenceCloud.Space.homepage.id
description: ID of the homepage of the space.
type: String
- contextPath: ConfluenceCloud.Space.homepage.type
description: Type of the homepage of the space.
type: String
- contextPath: ConfluenceCloud.Space.homepage.status
description: Status of the homepage of the space.
type: String
- contextPath: ConfluenceCloud.Space.homepage.title
description: Title of the homepage of the space.
type: String
- contextPath: ConfluenceCloud.Space.homepage.extensions.position
description: The content extension position.
type: Number
- contextPath: ConfluenceCloud.Space.homepage._links.self
description: Link to the homepage of the space.
type: String
- contextPath: ConfluenceCloud.Space.homepage._links.tinyui
description: Tiny link to the homepage of the space.
type: String
- contextPath: ConfluenceCloud.Space.homepage._links.editui
description: Edit the user interface link to the homepage of the space.
type: String
- contextPath: ConfluenceCloud.Space.homepage._links.webui
description: Web user interface link to the homepage of the space.
type: String
- contextPath: ConfluenceCloud.Space.type
description: Type of the space.
type: String
- contextPath: ConfluenceCloud.Space.permissions.id
description: ID of the space permission.
type: Number
- contextPath: ConfluenceCloud.Space.permissions.subjects.user.results.type
description: Type of the user to whom the space permission applies.
type: String
- contextPath: ConfluenceCloud.Space.permissions.subjects.user.results.accountId
description: Account ID of the user to whom the space permission applies.
type: String
- contextPath: ConfluenceCloud.Space.permissions.subjects.user.results.accountType
description: Account type of the user to whom the space permission applies.
type: String
- contextPath: ConfluenceCloud.Space.permissions.subjects.user.results.email
description: Email of the user to whom the space permission applies.
type: String
- contextPath: ConfluenceCloud.Space.permissions.subjects.user.results.publicName
description: Public name to whom the space permission applies.
type: String
- contextPath: ConfluenceCloud.Space.permissions.subjects.user.results.profilePicture.path
description: Path of the user's profile picture to whom the space permission applies.
type: String
- contextPath: ConfluenceCloud.Space.permissions.subjects.user.results.profilePicture.width
description: Width in pixels of the user's profile picture to whom the space permission applies.
type: Number
- contextPath: ConfluenceCloud.Space.permissions.subjects.user.results.profilePicture.height
description: Height in pixels of the user's profile picture to whom the space permission applies.
type: Number
- contextPath: ConfluenceCloud.Space.permissions.subjects.user.results.profilePicture.isDefault
description: Whether the profile picture of the user is the default to whom the space permission applies.
type: Boolean
- contextPath: ConfluenceCloud.Space.permissions.subjects.user.results.displayName
description: Display name of the user to whom the space permission applies.
type: String
- contextPath: ConfluenceCloud.Space.permissions.subjects.user.results.isExternalCollaborator
description: Whether the user is an external collaborator user.
type: Boolean
- contextPath: ConfluenceCloud.Space.permissions.subjects.user.results._links.self
description: Link to the user to whom the space permission applies.
type: String
- contextPath: ConfluenceCloud.Space.permissions.subjects.user.size
description: Size of the list of users for the given space.
type: Number
- contextPath: ConfluenceCloud.Space.permissions.subjects.group.results.type
description: Type of the group to whom the space permission applies.
type: String
- contextPath: ConfluenceCloud.Space.permissions.subjects.group.results.name
description: Name of the group to whom the space permission applies.
type: String
- contextPath: ConfluenceCloud.Space.permissions.subjects.group.results.id
description: ID of the group to whom the space permission applies.
type: String
- contextPath: ConfluenceCloud.Space.permissions.subjects.group.results._links.self
description: Link to the group to whom the space permission applies.
type: String
- contextPath: ConfluenceCloud.Space.permissions.subjects.group.size
description: Size of the list of groups for the given space.
type: Number
- contextPath: ConfluenceCloud.Space.permissions.operation.operation
description: Name of the permission operation.
type: String
- contextPath: ConfluenceCloud.Space.permissions.operation.targetType
description: The space or content type that the operation applies to.
type: String
- contextPath: ConfluenceCloud.Space.permissions.anonymousAccess
description: Whether anonymous users have permission to use the operation.
type: Boolean
- contextPath: ConfluenceCloud.Space.permissions.unlicensedAccess
description: Whether unlicensed users have access from JIRA Service Desk when used with the read space operation.
type: Boolean
- contextPath: ConfluenceCloud.Space.status
description: Status of the space.
type: String
- contextPath: ConfluenceCloud.Space._links.webui
description: Web user interface link of the space.
type: String
- contextPath: ConfluenceCloud.Space._links.context
description: Context link of the space.
type: String
- contextPath: ConfluenceCloud.Space._links.self
description: Link to the space.
type: String
- contextPath: ConfluenceCloud.Space._links.collection
description: Collection link of the space.
type: String
- contextPath: ConfluenceCloud.Space._links.base
description: Base link to the space.
type: String
- arguments:
- defaultValue: '50'
description: |-
Number of records to retrieve in the response.
Note: The minimum value supported is 0 and the maximum value supported is int32.
name: limit