forked from finos/symphony-wdk
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathswadl-schema-1.0.json
4099 lines (4099 loc) · 181 KB
/
swadl-schema-1.0.json
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
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "SWADL (Symphony Workflow Automation Definition Language) is a language to describe workflows on Symphony.",
"default": {},
"type": "object",
"additionalProperties": false,
"required": [
"id",
"activities"
],
"properties": {
"id": {
"type": "string",
"description": "Workflow's id should start with a letter. It is optional. If no id is provided, the workflow filename is used. Otherwise, it will be generated. The id will appear in logs and audit trails.",
"pattern": "^[a-zA-Z]+[a-zA-Z0-9][^ ]*$",
"default": "my-workflow",
"maxLength": 100
},
"properties": {
"type": "object",
"description": "Some metadata about the workflow",
"properties": {
"publish": {
"type": [
"boolean",
"string"
],
"description": "Should the workflow be published or not, true publish, false otherwise",
"default": true
}
}
},
"variables": {
"type": "object",
"description": "Variables are accessible and editable within the entire workflow. A map of key: value entries is expected."
},
"activities": {
"type": "array",
"minLength": 1,
"description": "A list of activities to be executed by the workflow. By default the execution is sequential but complex logic can be orchestrated with if/else conditions as well as on/activity-completed events.",
"$comment": "Defined like this to support both validation and autocompletion, even with custom activities. Last item is removed on the fly during validation and replaced by known custom activities.",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"create-room": {
"description": "Creates a new chatroom.",
"x-intellij-html-description": "<html><p>Creates a new chatroom.\n</p><a href=\"https://developers.symphony.com/restapi/reference#create-room-v3\">https://developers.symphony.com/restapi/reference#create-room-v3</a></html>",
"allOf": [
{
"$ref": "#/definitions/basic-activity-inner"
},
{
"$ref": "#/definitions/create-room-inner"
}
]
},
"update-room": {
"description": "Updates the attributes of an existing chat room.",
"x-intellij-html-description": "<html><p>Updates the attributes of an existing chat room.\n</p><a href=\"https://developers.symphony.com/restapi/reference#update-room-v3\">https://developers.symphony.com/restapi/reference#update-room-v3</a></html>",
"allOf": [
{
"$ref": "#/definitions/basic-activity-inner"
},
{
"$ref": "#/definitions/update-room-inner"
}
]
},
"add-room-member": {
"description": "Adds new members to an existing room.",
"x-intellij-html-description": "<html><p>Adds a new members to an existing room.\n</p><a href=\"https://developers.symphony.com/restapi/reference#add-member\">https://developers.symphony.com/restapi/reference#add-member</a></html>",
"allOf": [
{
"$ref": "#/definitions/basic-activity-inner"
},
{
"$ref": "#/definitions/add-room-member-inner"
}
]
},
"remove-room-member": {
"description": "Removes members from an existing room.",
"x-intellij-html-description": "<html><p>Removes members from an existing room.\n</p><a href=\"https://developers.symphony.com/restapi/reference#remove-member\">https://developers.symphony.com/restapi/reference#remove-member</a></html>",
"allOf": [
{
"$ref": "#/definitions/basic-activity-inner"
},
{
"$ref": "#/definitions/remove-room-member-inner"
}
]
},
"promote-room-owner": {
"description": "Promotes user to owner of the chat room.",
"x-intellij-html-description": "<html><p>Promotes user to owner of the chat room.\n</p><a href=\"https://developers.symphony.com/restapi/reference#promote-owner\">https://developers.symphony.com/restapi/reference#promote-owner</a></html>",
"allOf": [
{
"$ref": "#/definitions/basic-activity-inner"
},
{
"$ref": "#/definitions/promote-room-owner-inner"
}
]
},
"demote-room-owner": {
"description": "Demotes room owner to a participant in the chat room.",
"x-intellij-html-description": "<html><p>Demotes room owner to a participant in the chat room.</p><a href=\"https://developers.symphony.com/restapi/reference#demote-owner\">https://developers.symphony.com/restapi/reference#demote-owner</a></html>",
"allOf": [
{
"$ref": "#/definitions/basic-activity-inner"
},
{
"$ref": "#/definitions/demote-room-owner-inner"
}
]
},
"send-message": {
"description": "Posts a message to a stream.",
"x-intellij-html-description": "<html><p>Posts a message to a stream.</p><a href=\"https://developers.symphony.com/restapi/reference#create-message-v4\">https://developers.symphony.com/restapi/reference#create-message-v4</a></html>",
"allOf": [
{
"$ref": "#/definitions/basic-activity-inner"
},
{
"$ref": "#/definitions/send-message-inner"
}
]
},
"update-message": {
"description": "Updates an existing message into a stream.",
"x-intellij-html-description": "<html><p>Updates an existing message into a stream.</p><a href=\"https://developers.symphony.com/restapi/reference#update-message-v4\">https://developers.symphony.com/restapi/reference#update-message-v4</a></html>",
"allOf": [
{
"$ref": "#/definitions/basic-activity-inner"
},
{
"$ref": "#/definitions/update-message-inner"
}
]
},
"pin-message": {
"description": "Pin an existing message into the stream it belongs to.",
"x-intellij-html-description": "<html><p>Pin an existing message into the stream it belongs to.<a href=\"https://developers.symphony.com/restapi/reference#update-room-v3\">https://developers.symphony.com/restapi/reference#update-room-v3</a><a href=\"https://developers.symphony.com/restapi/v20.13/reference#update-im\">(https://developers.symphony.com/restapi/v20.13/reference#update-im</a></html>",
"allOf": [
{
"$ref": "#/definitions/basic-activity-inner"
},
{
"$ref": "#/definitions/pin-message-inner"
}
]
},
"unpin-message": {
"description": "Unpin any message (if present) from an existing stream.",
"x-intellij-html-description": "<html><p>Unpin any message (if present) from an existing stream.</p><a href=\"https://developers.symphony.com/restapi/reference#update-room-v3\">https://developers.symphony.com/restapi/reference#update-room-v3</a><a href=\"https://developers.symphony.com/restapi/v20.13/reference#update-im\">(https://developers.symphony.com/restapi/v20.13/reference#update-im</a></html>",
"allOf": [
{
"$ref": "#/definitions/basic-activity-inner"
},
{
"$ref": "#/definitions/unpin-message-inner"
}
]
},
"get-attachment": {
"description": "Gets one attachment and stores it locally.",
"x-intellij-html-description": "<html><p>Gets one attachment and stores it locally.</p><a href=\"https://developers.symphony.com/restapi/reference#attachment\">https://developers.symphony.com/restapi/reference#attachment</a></html>",
"allOf": [
{
"$ref": "#/definitions/basic-activity-inner"
},
{
"$ref": "#/definitions/get-attachment-inner"
}
]
},
"debug": {
"description": "Standard debug activity.",
"x-intellij-html-description": "<html><p>Standard debug activity.</p></html>",
"type": "object",
"properties": {
"id": {
"description": "Activity's identifier, should be unique across workflow. As it can be used as a variable identifier only alphanumerical characters are allowed.",
"type": "string",
"$comment": "variables is forbidden to avoid conflict with variables.output... that would override the workflows variables",
"pattern": "^(?!variables$)([a-zA-Z][a-zA-Z0-9_]+)$"
},
"on": {
"$ref": "#/definitions/on"
},
"if": {
"description": "Conditional execution of the activity based on a boolean expression.",
"type": "string"
},
"else": {
"description": "Default execution of the activity when if conditions are used for previous activities.",
"type": "object"
},
"object": {
"type": [
"object",
"string"
]
}
},
"required": [
"object"
]
},
"execute-script": {
"description": "Executes a Groovy script.",
"x-intellij-html-description": "<html><p>Executes a Groovy script.</p></html>",
"allOf": [
{
"$ref": "#/definitions/basic-activity-inner"
},
{
"$ref": "#/definitions/execute-script-inner"
}
]
},
"execute-request": {
"description": "Executes an HTTP request.",
"allOf": [
{
"$ref": "#/definitions/basic-activity-inner"
},
{
"$ref": "#/definitions/execute-request-inner"
}
]
},
"create-user": {
"description": "Creates a new end user.",
"x-intellij-html-description": "<html><p>Creates a new end user.</p><a href=\"https://developers.symphony.com/restapi/reference#create-user-v2\">https://developers.symphony.com/restapi/reference#create-user-v2</a></html>",
"allOf": [
{
"$ref": "#/definitions/basic-activity-inner"
},
{
"$ref": "#/definitions/create-user-inner",
"required": [
"email",
"username",
"firstname",
"lastname",
"display-name"
]
}
]
},
"update-user": {
"description": "Updates an existing end user.",
"x-intellij-html-description": "<html><p>Updates an existing end user.</p><a href=\"https://developers.symphony.com/restapi/reference#update-user-v2\">https://developers.symphony.com/restapi/reference#update-user-v2</a></html>",
"allOf": [
{
"$ref": "#/definitions/basic-activity-inner"
},
{
"$ref": "#/definitions/create-user-inner"
},
{
"type": "object",
"properties": {
"user-id": {
"$ref": "#/definitions/user-id"
}
},
"required": [
"user-id"
]
}
]
},
"create-system-user": {
"description": "Creates a new service user.",
"x-intellij-html-description": "<html><p>Creates a new service user.</p><a href=\"https://developers.symphony.com/restapi/reference#create-user-v2\">https://developers.symphony.com/restapi/reference#create-user-v2</a></html>",
"allOf": [
{
"$ref": "#/definitions/basic-activity-inner"
},
{
"$ref": "#/definitions/create-system-user-inner",
"required": [
"email",
"username",
"display-name"
]
}
]
},
"update-system-user": {
"description": "Updates an existing service user.",
"x-intellij-html-description": "<html><p>Updates an existing service user.</p><a href=\"https://developers.symphony.com/restapi/reference#update-user-v2\">https://developers.symphony.com/restapi/reference#update-user-v2</a></html>",
"allOf": [
{
"$ref": "#/definitions/basic-activity-inner"
},
{
"$ref": "#/definitions/create-system-user-inner"
},
{
"type": "object",
"properties": {
"user-id": {
"$ref": "#/definitions/user-id"
}
},
"required": [
"user-id"
]
}
]
},
"add-user-role": {
"description": "Adds roles to user accounts.",
"x-intellij-html-description": "<html><p>Adds a role or optional entitleable action to a user’s account.</p><a href=\"https://developers.symphony.com/restapi/reference#add-role\">https://developers.symphony.com/restapi/reference#add-role</a></html>",
"allOf": [
{
"$ref": "#/definitions/basic-activity-inner"
},
{
"$ref": "#/definitions/user-role-inner"
}
]
},
"remove-user-role": {
"description": "Removes roles from user accounts.",
"x-intellij-html-description": "<html><p>Removes a role or optional entitleable action from a user’s account.</p><a href=\"https://developers.symphony.com/restapi/reference#remove-role\">https://developers.symphony.com/restapi/reference#remove-role</a></html>",
"allOf": [
{
"$ref": "#/definitions/basic-activity-inner"
},
{
"$ref": "#/definitions/user-role-inner"
}
]
},
"get-user": {
"description": "Returns details for a particular user.",
"x-intellij-html-description": "<html><p>Returns details for a particular user.</p><a href=\"https://developers.symphony.com/restapi/reference#get-user-v2\">https://developers.symphony.com/restapi/reference#get-user-v2</a></html>",
"type": "object",
"allOf": [
{
"$ref": "#/definitions/basic-activity-inner"
},
{
"$ref": "#/definitions/get-user-inner"
}
]
},
"get-users": {
"description": "Returns a list of users ID, including user metadata.",
"x-intellij-html-description": "<html><p>Returns a list of users ID, including user metadata.</p><a href=\"https://developers.symphony.com/restapi/reference#users-lookup-v3\">https://developers.symphony.com/restapi/reference#users-lookup-v3</a></html>",
"type": "object",
"allOf": [
{
"$ref": "#/definitions/basic-activity-inner"
},
{
"$ref": "#/definitions/get-users-inner"
}
]
},
"get-stream": {
"type": "object",
"description": "Returns information about a particular stream.",
"x-intellij-html-description": "<htmL><p>Returns information about a particular stream.</p><a href=\"https://developers.symphony.com/restapi/reference#stream-info-v2\">https://developers.symphony.com/restapi/reference#stream-info-v2</a></html",
"allOf": [
{
"$ref": "#/definitions/basic-activity-inner"
},
{
"$ref": "#/definitions/get-stream-inner"
}
]
},
"get-room": {
"type": "object",
"description": "Returns information about a particular chat room.",
"x-intellij-html-description": "<html><p>Returns information about a particular chat room.</p><a href=\"https://developers.symphony.com/restapi/reference#room-info-v3\">https://developers.symphony.com/restapi/reference#room-info-v3</a></html>",
"allOf": [
{
"$ref": "#/definitions/basic-activity-inner"
},
{
"$ref": "#/definitions/get-room-inner"
}
]
},
"get-message": {
"type": "object",
"description": "Returns a message found by id.",
"x-intellij-html-description": "<html><p>Returns a message found by id.</p><a href=\"https://developers.symphony.com/restapi/reference#get-message-v1\">https://developers.symphony.com/restapi/reference#get-message-v1</html>",
"allOf": [
{
"$ref": "#/definitions/basic-activity-inner"
},
{
"$ref": "#/definitions/get-message-inner"
}
]
},
"get-stream-members": {
"type": "object",
"description": "Returns a list of all the current members of a stream (IM, MIM, or chatroom).",
"x-intellij-html-description": "<html><p>Returns a list of all the current members of a stream (IM, MIM, or chatroom).</p><a href=\"https://developers.symphony.com/restapi/reference#stream-members\">https://developers.symphony.com/restapi/reference#stream-members</a></html>",
"allOf": [
{
"$ref": "#/definitions/basic-activity-inner"
},
{
"$ref": "#/definitions/get-stream-members-inner"
}
]
},
"get-room-members": {
"type": "object",
"description": "Lists the current members of an existing room.",
"x-intellij-html-description": "<html><p>Lists the current members of an existing room.</p><a href=\"https://developers.symphony.com/restapi/reference#room-members\">https://developers.symphony.com/restapi/reference#room-members</a></html>",
"allOf": [
{
"$ref": "#/definitions/basic-activity-inner"
},
{
"$ref": "#/definitions/get-room-members-inner"
}
]
},
"get-user-streams": {
"type": "object",
"description": "Returns a list of all the streams of which the requesting user is a member, sorted by creation date (ascending - oldest to newest).",
"x-intellij-html-description": "<html><p>Returns a list of all the streams of which the requesting user is a member, sorted by creation date (ascending - oldest to newest).</p><a href=\"https://developers.symphony.com/restapi/reference#list-user-streams\">https://developers.symphony.com/restapi/reference#list-user-streams</a></html>",
"allOf": [
{
"$ref": "#/definitions/basic-activity-inner"
},
{
"$ref": "#/definitions/get-user-streams-inner"
}
]
},
"get-streams": {
"type": "object",
"description": "Returns a list of all the streams (IMs, MIMs, and chatrooms) for the calling user's company, sorted by creation date (ascending – oldest to newest).",
"x-intellij-html-description": "<html><p>Returns a list of all the streams (IMs, MIMs, and chatrooms) for the calling user's company, sorted by creation date (ascending – oldest to newest).</p><a href\"https://developers.symphony.com/restapi/reference#list-streams-for-enterprise-v2\">https://developers.symphony.com/restapi/reference#list-streams-for-enterprise-v2</a></html>",
"allOf": [
{
"$ref": "#/definitions/basic-activity-inner"
},
{
"$ref": "#/definitions/get-streams-inner"
}
]
},
"get-connection": {
"type": "object",
"description": "Get one connection status.",
"x-intellij-html-description": "<html><p>Get one connection status.</p><a href=\"https://developers.symphony.com/restapi/reference#get-connection\">https://developers.symphony.com/restapi/reference#get-connection</a></html>",
"allOf": [
{
"$ref": "#/definitions/basic-activity-inner"
},
{
"$ref": "#/definitions/connection-inner"
}
]
},
"create-connection": {
"type": "object",
"description": "Send a connection request to another user.",
"x-intellij-html-description": "<html><p>Send a connection request to another user.</p><a href=\"https://developers.symphony.com/restapi/reference#create-connection\">https://developers.symphony.com/restapi/reference#create-connection</a></html>",
"allOf": [
{
"$ref": "#/definitions/basic-activity-inner"
},
{
"$ref": "#/definitions/connection-inner"
}
]
},
"accept-connection": {
"type": "object",
"description": "Accept the connection request for a requesting user.",
"x-intellij-html-description": "<html><p>Accept the connection request for a requesting user.</p><a href=\"https://developers.symphony.com/restapi/reference#accepted-connection\">https://developers.symphony.com/restapi/reference#accepted-connection</a></html>",
"allOf": [
{
"$ref": "#/definitions/basic-activity-inner"
},
{
"$ref": "#/definitions/connection-inner"
}
]
},
"reject-connection": {
"type": "object",
"description": "Reject the connection request from a requesting user.",
"x-intellij-html-description": "<html><p>Reject the connection request from a requesting user.</p><a href=\"https://developers.symphony.com/restapi/reference#reject-connection\">https://developers.symphony.com/restapi/reference#reject-connection</a></html>",
"allOf": [
{
"$ref": "#/definitions/basic-activity-inner"
},
{
"$ref": "#/definitions/connection-inner"
}
]
},
"remove-connection": {
"type": "object",
"description": "Remove a connection with a user.",
"x-intellij-html-description": "<html><p>Remove a connection with a user.</p><a href=\"https://developers.symphony.com/restapi/reference#remove-connection\">https://developers.symphony.com/restapi/reference#remove-connection</a></html>",
"allOf": [
{
"$ref": "#/definitions/basic-activity-inner"
},
{
"$ref": "#/definitions/connection-inner"
}
]
},
"get-rooms": {
"type": "object",
"description": "Search for rooms, querying name, description, and specified keywords.",
"x-intellij-html-description": "<html><p>Search for rooms, querying name, description, and specified keywords.</p><a href=\"https://developers.symphony.com/restapi/reference#search-rooms-v3\">https://developers.symphony.com/restapi/reference#search-rooms-v3</a></html>",
"allOf": [
{
"$ref": "#/definitions/basic-activity-inner"
},
{
"$ref": "#/definitions/get-rooms-inner"
}
]
},
"get-messages": {
"type": "object",
"description": "Get messages from an existing stream (IM, MIM, or chatroom).\nAdditionally returns any attachments associated with the message.",
"x-intellij-html-description": "<html><p>Get messages from an existing stream (IM, MIM, or chatroom).\nAdditionally returns any attachments associated with the message.</p><a href=\"https://developers.symphony.com/restapi/reference#messages-v4\">https://developers.symphony.com/restapi/reference#messages-v4</a></html>",
"allOf": [
{
"$ref": "#/definitions/basic-activity-inner"
},
{
"$ref": "#/definitions/get-messages-inner"
}
]
},
"get-connections": {
"type": "object",
"description": "Get one or multiple connections statuses",
"x-intellij-html-description": "<html><p>Get one or multiple connections statuses</p><a href=\"https://developers.symphony.com/restapi/reference#list-connections\">https://developers.symphony.com/restapi/reference#list-connections</a></html>",
"allOf": [
{
"$ref": "#/definitions/basic-activity-inner"
},
{
"$ref": "#/definitions/get-connections-inner"
}
]
},
"create-group": {
"type": "object",
"description": "Create a group (distribution list)",
"x-intellij-html-description": "<html><p>Create a group (distribution list)</p><a href=\"https://developers.symphony.com/restapi/reference/insertgroup\">https://developers.symphony.com/restapi/reference/insertgroup</a></html>",
"allOf": [
{
"$ref": "#/definitions/basic-activity-inner"
},
{
"$ref": "#/definitions/create-group-inner"
}
],
"required": [
"name",
"owner",
"members",
"profile"
]
},
"update-group": {
"type": "object",
"description": "Update a group (distribution list)",
"x-intellij-html-description": "<html><p>Update a group (distribution list)</p><a href=\"https://developers.symphony.com/restapi/reference/updategroup\">https://developers.symphony.com/restapi/reference/updategroup</a></html>",
"allOf": [
{
"$ref": "#/definitions/basic-activity-inner"
},
{
"$ref": "#/definitions/create-group-inner"
},
{
"type": "object",
"$ref": "#/definitions/update-group-inner"
}
]
},
"get-group": {
"type": "object",
"description": "Retrieve a group (distribution list)",
"x-intellij-html-description": "<html><p>Retrieve a group (distribution list)</p><a href=\"https://developers.symphony.com/restapi/reference/getgroup\">https://developers.symphony.com/restapi/reference/getgroup</a></html>",
"allOf": [
{
"$ref": "#/definitions/basic-activity-inner"
},
{
"$ref": "#/definitions/get-group-inner"
}
]
},
"get-groups": {
"type": "object",
"description": "Retrieve groups of specified type (distribution list)",
"x-intellij-html-description": "<html><p>Retrieve groups of specified type (distribution list)</p><a href=\"https://developers.symphony.com/restapi/reference/listgroups\">https://developers.symphony.com/restapi/reference/listgroups</a></html>",
"allOf": [
{
"$ref": "#/definitions/basic-activity-inner"
},
{
"$ref": "#/definitions/get-groups-inner"
}
]
},
"add-group-member": {
"type": "object",
"description": "Add members to a group (distribution list)",
"x-intellij-html-description": "<html><p>Add members to a group (distribution list)</p><a href=\"https://developers.symphony.com/restapi/reference/addmembertogroup\">https://developers.symphony.com/restapi/reference/addmembertogroup</a></html>",
"allOf": [
{
"$ref": "#/definitions/basic-activity-inner"
},
{
"$ref": "#/definitions/add-group-member-inner"
}
]
}
},
"maxProperties": 1,
"minProperties": 1,
"patternProperties": {
"^(?!create-room|update-room|add-room-member|remove-room-member|promote-room-owner|demote-room-owner|send-message|update-message|pin-message|unpin-message|debug|execute-script|execute-request|create-user|create-system-user|create-connection|update-user|update-system-user|add-user-role|remove-user-role|remove-connection|reject-connection|accept-connection|get-user|get-users|get-stream|get-room|get-message|get-connection|get-stream-members|get-room-members|get-user-streams|get-streams|get-rooms|get-messages|get-connections)([a-z0-9-]+)$": {
"$comment": "Match everything that is not an already known activity to allow for custom activities to be used.",
"$ref": "#/definitions/basic-activity-inner"
}
}
}
}
},
"definitions": {
"search-user-inner": {
"type": "object",
"properties": {
"local": {
"type": [
"boolean",
"string"
],
"description": "If true then a local DB search will be performed and only local pod users will be returned. If absent or false then a directory search will be performed and users from other pods who are visible to the calling user will also be returned.",
"default": false
},
"active": {
"type": [
"boolean",
"string"
],
"description": "If true, it searches for active users only. If false, it searches for inactive users only. If not set, it searches for all users regardless of their status."
}
}
},
"on": {
"description": "Events that can trigger the activity execution.",
"x-intellij-html-description": "<html><p>Events that can trigger the activity execution.</p><a href=\"https://docs.developers.symphony.com/building-bots-on-symphony/datafeed/real-time-events\">List of real-time events: https://docs.developers.symphony.com/building-bots-on-symphony/datafeed/real-time-events</a></html>",
"type": "object",
"allOf": [
{
"type": "object",
"properties": {
"timeout": {
"type": "string",
"description": "Timeout while waiting for form-replied events, expressed as an ISO 8601 duration. Default value is 24 hours.",
"pattern": "^P(?!$)(\\d+(?:\\.\\d+)?Y)?(\\d+(?:\\.\\d+)?M)?(\\d+(?:\\.\\d+)?W)?(\\d+(?:\\.\\d+)?D)?(T(?=\\d)(\\d+(?:\\.\\d+)?H)?(\\d+(?:\\.\\d+)?M)?(\\d+(?:\\.\\d+)?S)?)?$"
}
}
},
{
"oneOf": [
{
"$ref": "#/definitions/form-replied-event"
},
{
"$ref": "#/definitions/activity-expired-event"
},
{
"$ref": "#/definitions/activity-completed-event"
},
{
"$ref": "#/definitions/activity-failed-event"
},
{
"$ref": "#/definitions/message-received-event"
},
{
"$ref": "#/definitions/request-received-event"
},
{
"$ref": "#/definitions/message-suppressed-event"
},
{
"$ref": "#/definitions/post-shared-event"
},
{
"$ref": "#/definitions/im-created-event"
},
{
"$ref": "#/definitions/room-created-event"
},
{
"$ref": "#/definitions/room-updated-event"
},
{
"$ref": "#/definitions/room-deactivated-event"
},
{
"$ref": "#/definitions/room-reactivated-event"
},
{
"$ref": "#/definitions/room-member-promoted-to-owner-event"
},
{
"$ref": "#/definitions/room-member-demoted-from-owner-event"
},
{
"$ref": "#/definitions/user-joined-room-event"
},
{
"$ref": "#/definitions/user-left-room-event"
},
{
"$ref": "#/definitions/user-requested-join-room-event"
},
{
"$ref": "#/definitions/connection-requested-event"
},
{
"$ref": "#/definitions/connection-accepted-event"
},
{
"$ref": "#/definitions/timer-fired-event"
},
{
"$ref": "#/definitions/one-of-event"
},
{
"$ref": "#/definitions/all-of-event"
}
]
}
]
},
"form-replied-event": {
"type": "object",
"properties": {
"form-replied": {
"description": "Generated when a user replies to a bot message that contains an interactive form with UX components such as text fields, radio buttons, checkboxes, person selectors and more.",
"x-intellij-html-description": "<html><p>Generated when a user replies to a bot message that contains an interactive form with UX components such as text fields, radio buttons, checkboxes, person selectors and more. Please refer to <a href=\"https://docs.developers.symphony.com/building-bots-on-symphony/symphony-elements\">Symphony Elements.</p><a href=\"https://docs.developers.symphony.com/building-bots-on-symphony/datafeed/real-time-events#symphony-elements-action\">https://docs.developers.symphony.com/building-bots-on-symphony/datafeed/real-time-events#symphony-elements-action</a></html>",
"$ref": "#/definitions/form-replied-event-inner"
}
},
"required": [
"form-replied"
]
},
"request-received-event": {
"title": "object",
"properties": {
"request-received": {
"description": "Generated when an HTTP request is received in order to trigger a workflow.",
"$ref": "#/definitions/request-received-event-inner"
}
},
"required": [
"request-received"
]
},
"message-received-event": {
"type": "object",
"properties": {
"message-received": {
"description": "Generated when a message is sent in an IM, MIM, or chatroom of which the workflow bot is a member, including messages sent by the user him/herself.",
"x-intellij-html-description": "<html><p>Generated when a message is sent in an IM, MIM, or chatroom of which the workflow bot is a member, including messages sent by the user him/herself.</p><a href=\"https://docs.developers.symphony.com/building-bots-on-symphony/datafeed/real-time-events#message-sent\">https://docs.developers.symphony.com/building-bots-on-symphony/datafeed/real-time-events#message-sent</a></html>",
"$ref": "#/definitions/message-received-event-inner"
}
},
"required": [
"message-received"
]
},
"message-suppressed-event": {
"type": "object",
"properties": {
"message-suppressed": {
"description": "Generated when messages are suppressed.",
"x-intellij-html-description": "<html><p>Generated when messages are suppressed.</p><a href=\"https://docs.developers.symphony.com/building-bots-on-symphony/datafeed/real-time-events#messages-suppressed\">https://docs.developers.symphony.com/building-bots-on-symphony/datafeed/real-time-events#messages-suppressed</a></html>",
"$ref": "#/definitions/message-suppressed-event-inner"
}
},
"required": [
"message-suppressed"
]
},
"post-shared-event": {
"type": "object",
"properties": {
"post-shared": {
"description": "Generated when either the workflow bot shares a wall post written by another user or another user shares a wall post written by the workflow bot.",
"x-intellij-html-description": "<html><p>Generated when either:<li>The workflow bot shares a wall post written by another user.</li><li>Another user shares a wall post written by the workflow bot.</li></p><a href=\"https://docs.developers.symphony.com/building-bots-on-symphony/datafeed/real-time-events#shared-wall-posts\">https://docs.developers.symphony.com/building-bots-on-symphony/datafeed/real-time-events#shared-wall-posts</a></html>",
"$ref": "#/definitions/post-shared-event-inner"
}
},
"required": [
"post-shared"
]
},
"im-created-event": {
"type": "object",
"properties": {
"im-created": {
"description": "Generated when an IM or MIM is created with the workflow bot as a member, initiated either by the workflow bot or another user.",
"x-intellij-html-description": "<html><p>Generated when an IM or MIM is created with the workflow bot as a member, initiated either by the workflow bot or another user.</p><a href=\"https://docs.developers.symphony.com/building-bots-on-symphony/datafeed/real-time-events#im-mim-created\">https://docs.developers.symphony.com/building-bots-on-symphony/datafeed/real-time-events#im-mim-created</a></html>",
"$ref": "#/definitions/im-created-event-inner"
}
},
"required": [
"im-created"
]
},
"room-created-event": {
"type": "object",
"properties": {
"room-created": {
"description": "Generated when a room is created by the workflow bot.",
"x-intellij-html-description": "<html><p>Generated when a room is created by the workflow bot.</p><a href=\"https://docs.developers.symphony.com/building-bots-on-symphony/datafeed/real-time-events#room-created\">https://docs.developers.symphony.com/building-bots-on-symphony/datafeed/real-time-events#room-created</a></html>",
"$ref": "#/definitions/room-created-event-inner"
}
},
"required": [
"room-created"
]
},
"room-updated-event": {
"type": "object",
"properties": {
"room-updated": {
"description": "Generated when a room of which the workflow bot is a member is updated, including rooms updated by the user him/herself.",
"x-intellij-html-description": "<html><p>Generated when a room of which the workflow bot is a member is updated, including rooms updated by the user him/herself.</p><a href=\"https://docs.developers.symphony.com/building-bots-on-symphony/datafeed/real-time-events#room-updated-message\">https://docs.developers.symphony.com/building-bots-on-symphony/datafeed/real-time-events#room-updated-message</a></html>",
"$ref": "#/definitions/room-updated-event-inner"
}
},
"required": [
"room-updated"
]
},
"room-deactivated-event": {
"type": "object",
"properties": {
"room-deactivated": {
"description": "Generated when a room of which the workflow bot is a member is deactivated, including rooms deactivated by the user him/herself.",
"x-intellij-html-description": "<html><p>Generated when a room of which the workflow bot is a member is deactivated, including rooms deactivated by the user him/herself.</p><a href=\"https://docs.developers.symphony.com/building-bots-on-symphony/datafeed/real-time-events#room-deactivated-message\">https://docs.developers.symphony.com/building-bots-on-symphony/datafeed/real-time-events#room-deactivated-message</a></html>",
"$ref": "#/definitions/room-deactivated-event-inner"
}
},
"required": [
"room-deactivated"
]
},
"room-reactivated-event": {
"type": "object",
"properties": {
"room-reactivated": {
"description": "Generated when a room of which the workflow bot is a member is reactivated, including rooms reactivated by the user him/herself.",
"x-intellij-html-description": "<html><p>Generated when a room of which the workflow bot is a member is reactivated, including rooms reactivated by the user him/herself.</p><a href=\"https://docs.developers.symphony.com/building-bots-on-symphony/datafeed/real-time-events#room-reactivated-message\">https://docs.developers.symphony.com/building-bots-on-symphony/datafeed/real-time-events#room-reactivated-message</a></html>",
"$ref": "#/definitions/room-reactivated-event-inner"
}
},
"required": [
"room-reactivated"
]
},
"room-member-promoted-to-owner-event": {
"type": "object",
"properties": {
"room-member-promoted-to-owner": {
"description": "Generated when a user is promoted from a participant to an owner of a room of which the workflow bot is a member, including when the user himself is promoted to an owner or promotes another user.",
"x-intellij-html-description": "<html><p>Generated when a user is promoted from a participant to an owner of a room of which the workflow bot is a member, including when the user himself is promoted to an owner or promotes another user.</p><a href=\"https://docs.developers.symphony.com/building-bots-on-symphony/datafeed/real-time-events#room-member-promoted-to-owner\">https://docs.developers.symphony.com/building-bots-on-symphony/datafeed/real-time-events#room-member-promoted-to-owner</a></html>",
"$ref": "#/definitions/room-member-promoted-to-owner-event-inner"
}
},
"required": [
"room-member-promoted-to-owner"
]
},
"room-member-demoted-from-owner-event": {
"type": "object",
"properties": {
"room-member-demoted-from-owner": {
"description": "Generated when a user is demoted from an owner to a participant of a room of which the workflow bot is a member, including when the user himself is demoted to a participant or demotes another user.",
"x-intellij-html-description": "<html><p>Generated when a user is demoted from an owner to a participant of a room of which the workflow bot is a member, including when the user himself is demoted to a participant or demotes another user.</p><a href=\"https://docs.developers.symphony.com/building-bots-on-symphony/datafeed/real-time-events#room-member-demoted-from-owner\">https://docs.developers.symphony.com/building-bots-on-symphony/datafeed/real-time-events#room-member-demoted-from-owner</a></html>",
"$ref": "#/definitions/room-member-demoted-from-owner-event-inner"
}
},
"required": [
"room-member-demoted-from-owner"
]
},
"user-joined-room-event": {
"type": "object",
"properties": {
"user-joined-room": {
"description": "Generated when a new user joins or is added to a room of which the workflow bot is a member, including when the user himself joins or is added to a room.",
"x-intellij-html-description": "<html><p>Generated when a new user joins or is added to a room of which the workflow bot is a member, including when the user himself joins or is added to a room.</p><a href=\"https://docs.developers.symphony.com/building-bots-on-symphony/datafeed/real-time-events#user-joined-room\">https://docs.developers.symphony.com/building-bots-on-symphony/datafeed/real-time-events#user-joined-room</a></html>",
"$ref": "#/definitions/user-joined-room-event-inner"
}
},
"required": [
"user-joined-room"
]
},
"user-left-room-event": {
"type": "object",
"properties": {
"user-left-room": {
"description": "Generated when a user leaves or is removed from a room of which the workflow bot is a member, including when the user himself leaves or is removed from a room.",
"x-intellij-html-description": "<html><p>Generated when a user leaves or is removed from a room of which the workflow bot is a member, including when the user himself leaves or is removed from a room.</p><a href=\"https://docs.developers.symphony.com/building-bots-on-symphony/datafeed/real-time-events#user-left-room\">https://docs.developers.symphony.com/building-bots-on-symphony/datafeed/real-time-events#user-left-room</a></html>",
"$ref": "#/definitions/user-left-room-event-inner"
}
},
"required": [
"user-left-room"
]
},
"user-requested-join-room-event": {
"type": "object",
"properties": {
"user-requested-join-room": {
"description": "Generated when a user requests to join a room. Only the user who requested to join the room and the owners of that room will receive this event on their datafeeds.",
"x-intellij-html-description": "<html><p>Generated when a user requests to join a room. Only the user who requested to join the room and the owners of that room will receive this event on their datafeeds.</p><a href=\"https://docs.developers.symphony.com/building-bots-on-symphony/datafeed/real-time-events#user-requested-to-join-room\">https://docs.developers.symphony.com/building-bots-on-symphony/datafeed/real-time-events#user-requested-to-join-room</a></html>",
"$ref": "#/definitions/user-requested-join-room-event-inner"
}
},
"required": [
"user-requested-join-room"
]
},
"connection-requested-event": {
"type": "object",
"properties": {
"connection-requested": {
"description": "Generated when a connection request is sent, either by the workflow bot to another user or to the workflow bot by another user.",
"x-intellij-html-description": "<html><p>Generated when a connection request is sent, either:<li>Sent by the workflow bot to another user.</li><li>Sent to the workflow bot by another user.</li></p><a href=\"https://docs.developers.symphony.com/building-bots-on-symphony/datafeed/real-time-events#connection-requested\">https://docs.developers.symphony.com/building-bots-on-symphony/datafeed/real-time-events#connection-requested</a></html>",
"$ref": "#/definitions/connection-requested-event-inner"
}
},
"required": [
"connection-requested"
]
},
"connection-accepted-event": {
"type": "object",
"properties": {
"connection-accepted": {
"description": "Generated when a connection request is accepted, either sent by the workflow bot and accepted by another user or sent by another user and accepted by the workflow bot.",
"x-intellij-html-description": "<html><p>Generated when a connection request is accepted, either:<li>Sent by the workflow bot and accepted by another user.</li><li>Sent by another user and accepted by the workflow bot.</li></p><a href=\"https://docs.developers.symphony.com/building-bots-on-symphony/datafeed/real-time-events#connection-accepted\">https://docs.developers.symphony.com/building-bots-on-symphony/datafeed/real-time-events#connection-accepted</a></html>",
"$ref": "#/definitions/connection-accepted-event-inner"
}
},
"required": [
"connection-accepted"
]
},
"activity-expired-event": {
"type": "object",
"properties": {
"activity-expired": {
"description": "Generated when the given activity event timeout has expired. Note this is not a Datafeed real-time event.",
"$ref": "#/definitions/activity-expired-event-inner"
}
},
"required": [
"activity-expired"
]
},
"activity-failed-event": {
"type": "object",
"properties": {
"activity-failed": {
"description": "Generated when the given activity has failed. Note this is not a Datafeed real-time event.",
"$ref": "#/definitions/activity-failed-event-inner"
}
},
"required": [
"activity-failed"