-
Notifications
You must be signed in to change notification settings - Fork 48
/
Copy pathagent-api-public-deprecated.yaml
7613 lines (7546 loc) · 249 KB
/
agent-api-public-deprecated.yaml
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
openapi: 3.0.1
info:
title: Agent API
description: |
This document refers to Symphony API calls to send and receive messages
and content. They need the on-premise Agent installed to perform
decryption/encryption of content.
- sessionToken and keyManagerToken can be obtained by calling the
authenticationAPI on the symphony back end and the key manager
respectively. Refer to the methods described in authenticatorAPI.yaml.
- Actions are defined to be atomic, ie will succeed in their entirety
or fail and have changed nothing.
- If it returns a 40X status then it will have sent no message to any
stream even if a request to some subset of the requested streams
would have succeeded.
- If this contract cannot be met for any reason then this is an error
and the response code will be 50X.
- MessageML is a markup language for messages. See reference here:
https://rest-api.symphony.com/docs/messagemlv2
- **Real Time Events**: The following events are returned when reading
from a real time messages and events stream ("datafeed"). These
events will be returned for datafeeds created with the v5 endpoints.
To know more about the endpoints, refer to Create Messages/Events
Stream and Read Messages/Events Stream. Unless otherwise specified,
all events were added in 1.46.
version: 24.12.1
servers:
- url: 'youragentURL.symphony.com/agent'
paths:
/v3/health:
get:
tags:
- System
summary: Checks health status
description: |
_Available on Agent 2.57.0 and above._
Returns the connectivity status of your Agent server. If your Agent server is started and running, the status value will be `UP`
operationId: v3Health
responses:
200:
description: Agent application is alive.
content:
application/json:
schema:
$ref: '#/components/schemas/V3Health'
/v3/health/extended:
get:
tags:
- System
summary: Checks health status of services and users
description: |
_Available on Agent 2.57.0 and above._
Returns the connectivity status of the Agent services (**pod**, **key manager** and **datafeed**) as well as users
connectivity (**agentservice** and **ceservice**).
The global status will be set to `DOWN` if at least one of the sub-status is also `DOWN`.
operationId: v3ExtendedHealth
responses:
200:
description: Agent is healthy, all components are `UP`.
content:
application/json:
schema:
$ref: '#/components/schemas/V3Health'
503:
description: Agent is unhealthy, some components are `DOWN`.
content:
application/json:
schema:
$ref: '#/components/schemas/V3Health'
/v4/message/import:
post:
tags:
- Messages
summary: Import messages from other systems into Symphony.
description: |
Sends a message to be imported into the system.
Allows you to override the timestamp and author of the message with your desired values.
The requesting user must have the Content Management role.
The user that the message is intended to have come from must also be present in the conversation.
The intended message timestamp must be a valid time from the past. It cannot be a future timestamp.
Optionally the original message ID can be specified to identify the imported message for the purpose of repeat imports.
parameters:
- name: sessionToken
in: header
description: Session authentication token.
required: true
schema:
type: string
- name: keyManagerToken
in: header
description: Key Manager authentication token.
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/V4MessageImportList'
required: true
responses:
200:
description: Message sent.
content:
application/json:
schema:
$ref: '#/components/schemas/V4ImportResponseList'
400:
description: Client error, see response body for further details.
content:
application/json:
schema:
$ref: '#/components/schemas/V2Error'
401:
description: 'Unauthorized: Session tokens invalid.'
content:
application/json:
schema:
$ref: '#/components/schemas/V2Error'
403:
description: 'Forbidden: Caller lacks necessary entitlement.'
content:
application/json:
schema:
$ref: '#/components/schemas/V2Error'
500:
description: Server error, see response body for further details.
content:
application/json:
schema:
$ref: '#/components/schemas/V2Error'
x-codegen-request-body-name: messageList
/v4/message/blast:
post:
tags:
- Messages
summary: Post a message to multiple existing streams.
description: |
Post a new message to the given list of streams. The stream can be a chatroom,
an IM or a multiparty IM.
You may include an attachment on the message.
The message can be provided as MessageMLV2 or PresentationML. Both formats support Freemarker templates.
The optional parameter "data" can be used to provide a JSON payload containing entity data.
If the message contains explicit references to entity data (in "data-entity-id" element attributes),
this parameter is required.
If the message is in MessageML and fails schema validation a client error results
This endpoint is idempotent, it means that a 200 response will be returned even if the message has not been
delivered to some streams. Check the `errors` map from the response in order to see on which stream(s) the
message has not been delivered.
The maximum number of streams where the message can be sent is limitted to 100.
Regarding authentication, you must either use the sessionToken which was created for delegated app access
or both the sessionToken and keyManagerToken together.
parameters:
- name: sessionToken
in: header
description: Authorization token used to make delegated calls.
required: true
schema:
type: string
- name: keyManagerToken
in: header
description: Key Manager authentication token.
schema:
type: string
requestBody:
content:
multipart/form-data:
schema:
required:
- sids
properties:
sids:
type: array
description: A comma-separated list of Stream IDs
items:
type: string
message:
type: string
description: The message payload in MessageML.
data:
type: string
description: Optional message data in EntityJSON.
version:
type: string
description: |
Optional message version in the format "major.minor". If empty, defaults to the latest supported version.
attachment:
type: string
description: Optional file attachment.
format: binary
preview:
type: string
description: Optional attachment preview.
format: binary
responses:
200:
description: Blast message sent.
content:
application/json:
schema:
$ref: '#/components/schemas/V4MessageBlastResponse'
400:
description: Client error, see response body for further details.
content:
application/json:
schema:
$ref: '#/components/schemas/V2Error'
401:
description: 'Unauthorized: Session tokens invalid.'
content:
application/json:
schema:
$ref: '#/components/schemas/V2Error'
403:
description: 'Forbidden: Caller lacks necessary entitlement.'
content:
application/json:
schema:
$ref: '#/components/schemas/V2Error'
451:
description: Compliance Issues found in message or file
content:
application/json:
schema:
$ref: '#/components/schemas/V2Error'
500:
description: Server error, see response body for further details.
content:
application/json:
schema:
$ref: '#/components/schemas/V2Error'
/v1/message/{id}:
get:
tags:
- Messages
summary: Get a message by ID
parameters:
- name: sessionToken
in: header
description: Session authentication token.
required: true
schema:
type: string
- name: keyManagerToken
in: header
description: Key Manager authentication token.
schema:
type: string
- name: id
in: path
description: Message ID as a URL-safe string
required: true
schema:
type: string
responses:
200:
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/V4Message'
204:
description: No Messages.
content: {}
400:
description: Client error, see response body for further details.
content:
application/json:
schema:
$ref: '#/components/schemas/V2Error'
401:
description: 'Unauthorized: Session tokens invalid.'
content:
application/json:
schema:
$ref: '#/components/schemas/V2Error'
403:
description: 'Forbidden: Caller lacks necessary entitlement.'
content:
application/json:
schema:
$ref: '#/components/schemas/V2Error'
500:
description: Server error, see response body for further details.
content:
application/json:
schema:
$ref: '#/components/schemas/V2Error'
/v1/message/search:
get:
tags:
- Messages
summary: Search messages
description: |
Search messages according to the specified criteria. The "query" parameter takes a search query defined as
"field:value" pairs combined by the operator "AND" (e.g. "text:foo AND autor:bar"). Supported fields are
(case-insensitive): "text", "author", "hashtag", "cashtag", "mention", "signal", "fromDate", "toDate",
"streamId", "streamType".
"text" search requires a "streamId" to be specified.
"streamType" accepts one of the following values: "chat" (IMs and MIMs), "im", "mim", "chatroom", "post".
"signal" queries can only be combined with "fromDate", "toDate", "skip" and "limit" parameters.
parameters:
- name: query
in: query
description: The search query. See above for the query syntax.
required: true
schema:
type: string
- name: skip
in: query
description: No. of results to skip.
schema:
type: integer
- name: limit
in: query
description: Max no. of results to return. If no value is provided, 50 is the default.
schema:
type: integer
- name: scope
in: query
description: |
Describes where content should be searched for that query.
It can exclusively apply to Symphony content or to one Connector.
schema:
type: string
- name: sortDir
in: query
description: |
Messages sort direction : ASC or DESC (default to DESC)
schema:
type: string
- name: tier
in: query
description: |
Target search tier : hot, warm or all (default to hot)
schema:
type: string
- name: sessionToken
in: header
description: Session authentication token.
required: true
schema:
type: string
- name: keyManagerToken
in: header
description: Key Manager authentication token.
schema:
type: string
responses:
200:
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/V4MessageList'
204:
description: No Messages.
content: {}
400:
description: Client error, see response body for further details.
content:
application/json:
schema:
$ref: '#/components/schemas/V2Error'
401:
description: 'Unauthorized: Session tokens invalid.'
content:
application/json:
schema:
$ref: '#/components/schemas/V2Error'
403:
description: 'Forbidden: Caller lacks necessary entitlement.'
content:
application/json:
schema:
$ref: '#/components/schemas/V2Error'
500:
description: Server error, see response body for further details.
content:
application/json:
schema:
$ref: '#/components/schemas/V2Error'
post:
tags:
- Messages
summary: Search messages
description: Search messages according to the specified criteria.
parameters:
- name: skip
in: query
description: No. of results to skip.
schema:
type: integer
- name: limit
in: query
description: Max no. of results to return. If no value is provided, 50 is the default.
schema:
type: integer
- name: scope
in: query
description: |
Describes where content should be searched for that query.
It can exclusively apply to Symphony content or to one Connector.
schema:
type: string
- name: sortDir
in: query
description: |
Messages sort direction : ASC or DESC (default to DESC)
schema:
type: string
- name: tier
in: query
description: |
Target search tier : hot, warm or all (default to hot)
schema:
type: string
- name: sessionToken
in: header
description: Session authentication token.
required: true
schema:
type: string
- name: keyManagerToken
in: header
description: Key Manager authentication token.
schema:
type: string
requestBody:
description: The search query. See above for the query syntax.
content:
application/json:
schema:
$ref: '#/components/schemas/MessageSearchQuery'
required: true
responses:
200:
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/V4MessageList'
204:
description: No Messages.
content: {}
400:
description: Client error, see response body for further details.
content:
application/json:
schema:
$ref: '#/components/schemas/V2Error'
401:
description: 'Unauthorized: Session tokens invalid.'
content:
application/json:
schema:
$ref: '#/components/schemas/V2Error'
403:
description: 'Forbidden: Caller lacks necessary entitlement.'
content:
application/json:
schema:
$ref: '#/components/schemas/V2Error'
500:
description: Server error, see response body for further details.
content:
application/json:
schema:
$ref: '#/components/schemas/V2Error'
x-codegen-request-body-name: query
/v1/stream/{sid}/attachment:
get:
tags:
- Attachments
summary: Download an attachment.
description: Downloads the attachment body by the attachment ID, stream ID, and message ID.
parameters:
- name: sid
in: path
description: Stream ID
required: true
schema:
type: string
- name: fileId
in: query
description: The attachment ID (Base64-encoded)
required: true
schema:
type: string
- name: messageId
in: query
description: The ID of the message containing the attachment
required: true
schema:
type: string
- name: sessionToken
in: header
description: Session authentication token.
required: true
schema:
type: string
- name: keyManagerToken
in: header
description: Key Manager authentication token.
schema:
type: string
responses:
200:
description: Attachment body as Base64 encoded string.
content:
application/octet-stream:
schema:
type: string
format: byte
400:
description: Client error, see response body for further details.
content:
application/octet-stream:
schema:
$ref: '#/components/schemas/Error'
401:
description: 'Unauthorized: Session tokens invalid.'
content:
application/octet-stream:
schema:
$ref: '#/components/schemas/Error'
403:
description: 'Forbidden: Caller lacks necessary entitlement.'
content:
application/octet-stream:
schema:
$ref: '#/components/schemas/Error'
500:
description: Server error, see response body for further details.
content:
application/octet-stream:
schema:
$ref: '#/components/schemas/Error'
/v4/stream/{sid}/message:
get:
tags:
- Messages
summary: Get messages from an existing stream.
description: |
A caller can fetch all unseen messages by passing the timestamp of
the last message seen as the since parameter and the number of messages
with the same timestamp value already seen as the skip parameter. This
means that every message will be seen exactly once even in the case that
an additional message is processed with the same timestamp as the last
message returned by the previous call, and the case where there are
more than maxMessages with the same timestamp value.
This method is intended for historic queries and is generally reliable
but if guaranteed delivery of every message in real time is required
then the equivilent firehose method should be called.
parameters:
- name: sid
in: path
description: Stream ID
required: true
schema:
type: string
- name: since
in: query
description: |
Timestamp of first required message.
This is a long integer value representing milliseconds since
Jan 1 1970
required: true
schema:
type: integer
format: int64
- name: skip
in: query
description: No. of messages to skip.
schema:
type: integer
- name: limit
in: query
description: |
Max No. of messages to return. If no value is provided, 50 is the default. The maximum supported value is 500.
schema:
type: integer
- name: sessionToken
in: header
description: Session authentication token.
required: true
schema:
type: string
- name: keyManagerToken
in: header
description: Key Manager authentication token.
schema:
type: string
responses:
200:
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/V4MessageList'
204:
description: No Messages.
content: {}
400:
description: Client error, see response body for further details.
content:
application/json:
schema:
$ref: '#/components/schemas/V2Error'
401:
description: 'Unauthorized: Session tokens invalid.'
content:
application/json:
schema:
$ref: '#/components/schemas/V2Error'
403:
description: 'Forbidden: Caller lacks necessary entitlement.'
content:
application/json:
schema:
$ref: '#/components/schemas/V2Error'
500:
description: Server error, see response body for further details.
content:
application/json:
schema:
$ref: '#/components/schemas/V2Error'
/v4/stream/{sid}/message/create:
post:
tags:
- Messages
summary: Post a message to one existing stream.
description: |
Post a new message to the given stream. The stream can be a chatroom,,an IM or a multiparty IM.
You may include an attachment on the message.
The message can be provided as MessageMLV2 or PresentationML. Both formats support Freemarker templates.
The optional parameter "data" can be used to provide a JSON payload containing entity data.
If the message contains explicit references to entity data (in "data-entity-id" element attributes),
this parameter is required.
If the message is in MessageML and fails schema validation a client error will be returned.
If the message is sent then 200 is returned.
Regarding authentication, you must either use the sessionToken which was created for delegated app access
or both the sessionToken and keyManagerToken together.
parameters:
- name: sid
in: path
description: Stream ID
required: true
schema:
type: string
- name: sessionToken
in: header
description: Authorization token used to make delegated calls.
required: true
schema:
type: string
- name: keyManagerToken
in: header
description: Key Manager authentication token.
schema:
type: string
requestBody:
content:
multipart/form-data:
schema:
properties:
message:
type: string
description: The message payload in MessageML.
data:
type: string
description: Optional message data in EntityJSON.
version:
type: string
description: |
Optional message version in the format "major.minor". If empty, defaults to the latest supported version.
attachment:
type: string
description: Optional file attachment.
format: binary
preview:
type: string
description: Optional attachment preview.
format: binary
responses:
200:
description: Message sent.
content:
application/json:
schema:
$ref: '#/components/schemas/V4Message'
400:
description: Client error, see response body for further details.
content:
application/json:
schema:
$ref: '#/components/schemas/V2Error'
401:
description: 'Unauthorized: Session tokens invalid.'
content:
application/json:
schema:
$ref: '#/components/schemas/V2Error'
403:
description: 'Forbidden: Caller lacks necessary entitlement.'
content:
application/json:
schema:
$ref: '#/components/schemas/V2Error'
451:
description: Compliance Issues found in message or file
content:
application/json:
schema:
$ref: '#/components/schemas/V2Error'
500:
description: Server error, see response body for further details.
content:
application/json:
schema:
$ref: '#/components/schemas/V2Error'
/v4/stream/{sid}/message/{mid}/update:
post:
tags:
- Messages
summary: Update an existing message.
description: |
Update an existing message. The existing message must be a valid social message, that has not been deleted.
The message can be provided as MessageMLV2 or PresentationML. Both formats support Freemarker templates.
The optional parameter "data" can be used to provide a JSON payload containing entity data.
If the message contains explicit references to entity data (in "data-entity-id" element attributes),
this parameter is required.
Regarding authentication, you must either use the sessionToken which was created for delegated app access
or both the sessionToken and keyManagerToken together.
Starting with SBE v24.1, attachments are supported.
parameters:
- name: sid
in: path
description: Stream ID
required: true
schema:
type: string
- name: mid
in: path
description: ID of the message to be updated
required: true
schema:
type: string
- name: sessionToken
in: header
description: Authorization token used to make delegated calls.
required: true
schema:
type: string
- name: keyManagerToken
in: header
description: Key Manager authentication token.
schema:
type: string
requestBody:
content:
multipart/form-data:
schema:
properties:
message:
type: string
description: The message payload in MessageML.
data:
type: string
description: Optional message data in EntityJSON.
version:
type: string
description: |
Optional message version in the format "major.minor". If empty, defaults to the latest supported version.
attachment:
type: string
description: Optional file attachment.
format: binary
preview:
type: string
description: Optional attachment preview.
format: binary
silent:
type: string
description: |
Optional boolean field that will determine if the user/s should receive the message as read or not (true by default)
responses:
200:
description: Message sent.
content:
application/json:
schema:
$ref: '#/components/schemas/V4Message'
400:
description: Client error, see response body for further details.
content:
application/json:
schema:
$ref: '#/components/schemas/V2Error'
401:
description: 'Unauthorized: Session tokens invalid.'
content:
application/json:
schema:
$ref: '#/components/schemas/V2Error'
403:
description: 'Forbidden: Caller lacks necessary entitlement.'
content:
application/json:
schema:
$ref: '#/components/schemas/V2Error'
451:
description: Compliance Issues found in message or file
content:
application/json:
schema:
$ref: '#/components/schemas/V2Error'
500:
description: Server error, see response body for further details.
content:
application/json:
schema:
$ref: '#/components/schemas/V2Error'
/v3/stream/{sid}/share:
post:
tags:
- Share
summary: PROVISIONAL - Share a piece of content into Symphony
description: |
Given a 3rd party content (eg. news article), it can share to the given stream.
The stream can be a chatroom, an IM or a multiparty IM.
parameters:
- name: sid
in: path
description: Stream ID
required: true
schema:
type: string
- name: sessionToken
in: header
description: Session authentication token.
required: true
schema:
type: string
- name: keyManagerToken
in: header
description: Key Manager authentication token.
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ShareContent'
required: true
responses:
200:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/V2Message'
400:
description: Client error, see response body for further details.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
401:
description: 'Unauthorized: Session tokens invalid.'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
403:
description: 'Forbidden: Caller lacks necessary entitlement.'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
500:
description: Server error, see response body for further details.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
x-codegen-request-body-name: shareContent
/v1/util/echo:
post:
tags:
- Util
summary: Test endpoint, returns input.
parameters:
- name: sessionToken
in: header
description: Session authentication token.
required: true
schema:
type: string
- name: keyManagerToken
in: header
description: Key Manager authentication token.
schema:
type: string
requestBody:
description: Message in plain text
content:
application/json:
schema:
$ref: '#/components/schemas/SimpleMessage'
required: true
responses:
200:
description: Message sent.
content:
application/json:
schema:
$ref: '#/components/schemas/SimpleMessage'
400:
description: Client error, see response body for further details.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
401:
description: 'Unauthorized: Session tokens invalid.'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
403:
description: 'Forbidden: Caller lacks necessary entitlement.'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
500:
description: Server error, see response body for further details.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
x-codegen-request-body-name: echoInput
/v1/signals/list:
get:
tags:
- Signals
summary: |
List signals for the requesting user. This includes signals that the user has created and public signals
to which they subscribed.
parameters:
- name: sessionToken
in: header
description: Session authentication token.
required: true
schema:
type: string
- name: keyManagerToken
in: header
description: Key Manager authentication token.
schema:
type: string
- name: skip
in: query
description: No. of signals to skip.
schema:
type: integer
- name: limit
in: query
description: |
Max no. of signals to return. If no value is provided, 50 is the default. The maximum supported value is 500.
schema:
type: integer
responses:
200:
description: List of signals for the requesting user.
content:
application/json: