-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathopenapi-public-api.yaml
More file actions
2447 lines (2447 loc) · 68.9 KB
/
Copy pathopenapi-public-api.yaml
File metadata and controls
2447 lines (2447 loc) · 68.9 KB
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.0
paths:
/api/v1/events/create:
post:
operationId: create
parameters: []
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/CreateEventRequestDto"
responses:
"200":
description: Event created successfully
content:
application/json:
schema:
$ref: "#/components/schemas/CreateEventResponseDto"
example:
event:
id: 1
publicDomain: example.com
name: Sample Event
description: This is a sample event description.
startDate: 2023-10-01T00:00:00Z
endDate: 2023-10-02T00:00:00Z
timezone: UTC
logoUrl: https://example.com/logo.png
bannerImageUrl: https://example.com/banner.png
labels:
- label1
- label2
createdAt: 2023-09-01T00:00:00Z
updatedAt: 2023-09-02T00:00:00Z
languages:
- en
- fr
isRegistrationOpen: true
doorsOpenDate: 2023-10-01T08:00:00Z
templateId: tm1000
templateName: Interactive session
status: ok
security:
- ks: []
summary: Creates a new virtual event with provided configuration including name,
start/end dates, templates, and timezone settings
tags: &a1
- Events
/api/v1/events/delete:
post:
operationId: delete
parameters: []
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/DeleteEventRequestDto"
responses:
"200":
description: Event deleted successfully
content:
application/json:
schema:
$ref: "#/components/schemas/DeleteEventResponseDto"
example:
event:
id: 1
publicDomain: example.com
name: Sample Event
description: This is a sample event description.
startDate: 2023-10-01T00:00:00Z
endDate: 2023-10-02T00:00:00Z
timezone: UTC
logoUrl: https://example.com/logo.png
bannerImageUrl: https://example.com/banner.png
labels:
- label1
- label2
createdAt: 2023-09-01T00:00:00Z
updatedAt: 2023-09-02T00:00:00Z
languages:
- en
- fr
isRegistrationOpen: true
doorsOpenDate: 2023-10-01T08:00:00Z
templateId: tm1000
templateName: Interactive session
status: ok
security:
- ks: []
summary: Permanently removes an event by its ID, including all associated
resources and configurations
tags: *a1
/api/v1/events/list:
post:
operationId: list
parameters: []
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/ListEventRequestDto"
responses:
"200":
description: List of events
content:
application/json:
schema:
$ref: "#/components/schemas/ListEventResponseDto"
example:
events:
- id: 1
publicDomain: example.com
name: Sample Event
description: This is a sample event description.
startDate: 2023-10-01T00:00:00Z
endDate: 2023-10-02T00:00:00Z
timezone: UTC
logoUrl: https://example.com/logo.png
bannerImageUrl: https://example.com/banner.png
labels:
- label1
- label2
createdAt: 2023-09-01T00:00:00Z
updatedAt: 2023-09-02T00:00:00Z
languages:
- en
- fr
isRegistrationOpen: true
doorsOpenDate: 2023-10-01T08:00:00Z
templateId: tm1000
templateName: Interactive session
totalCount: 1
status: ok
security:
- ks: []
summary: Retrieves a paginated list of events with filtering and sorting options
to manage large event catalogs
tags: *a1
/api/v1/events/update:
post:
operationId: update
parameters: []
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/UpdateEventRequestDto"
responses:
"200":
description: Event updated successfully
content:
application/json:
schema:
$ref: "#/components/schemas/UpdateEventResponseDto"
example:
event:
id: 1
publicDomain: example.com
name: Sample Event
description: This is a sample event description.
startDate: 2023-10-01T00:00:00Z
endDate: 2023-10-02T00:00:00Z
timezone: UTC
logoUrl: https://example.com/logo.png
bannerImageUrl: https://example.com/banner.png
labels:
- label1
- label2
createdAt: 2023-09-01T00:00:00Z
updatedAt: 2023-09-02T00:00:00Z
languages:
- en
- fr
isRegistrationOpen: true
doorsOpenDate: 2023-10-01T08:00:00Z
templateId: tm1000
templateName: Interactive session
status: ok
security:
- ks: []
summary: Modifies an existing event's properties such as name, dates, banner,
logo, and other configuration settings
tags: *a1
/api/v1/events/duplicate:
post:
operationId: duplicate
parameters: []
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/DuplicateEventRequestDto"
responses:
"200":
description: Event duplication initiated successfully
content:
application/json:
schema:
$ref: "#/components/schemas/DuplicateEventResponseDto"
example:
jobId: 1234567890abcdef
status: ok
security:
- ks: []
summary: Creates a copy of an existing event with all its configurations,
returning a job ID to track the duplication process
tags: *a1
/api/v1/events/duplicateStatus:
post:
operationId: duplicateStatus
parameters: []
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/DuplicateStatusEventRequestDto"
responses:
"200":
description: Event duplication status retrieved successfully
content:
application/json:
schema:
$ref: "#/components/schemas/DuplicateStatusEventResponseDto"
example:
jobId: 1234567890abcdef
jobState: completed
eventId: abcdef1234567890
status: ok
security:
- ks: []
summary: Checks the status of an event duplication job, returning job state and
new event ID when complete
tags: *a1
/api/v1/sessions/create:
post:
operationId: create
parameters: []
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/CreateSessionRequestDto"
responses:
"200":
description: Session created successfully
content:
application/json:
schema:
$ref: "#/components/schemas/CreateSessionResponseDto"
example:
session:
id: 0_4q5ie48b
createdAt: 2024-01-01T12:00:00Z
updatedAt: 2024-01-02T12:00:00Z
name: Sample Session
description: This is a sample session description.
startDate: 2024-02-01T10:00:00Z
endDate: 2024-02-01T11:00:00Z
tags:
- QA
- Workshop
rsvpCount: 150
type: MeetingEntry
visibility: published
thumbnailUrl: https://example.com/thumbnail.png
status: ok
security:
- ks: []
summary: Creates a new session under the specified event with the provided
configuration
tags: &a2
- Sessions
/api/v1/sessions/list:
post:
operationId: list
parameters: []
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/ListSessionRequestDto"
responses:
"200":
description: List of sessions
content:
application/json:
schema:
$ref: "#/components/schemas/ListSessionResponseDto"
example:
sessions:
- id: 0_4q5ie48b
createdAt: 2024-01-01T12:00:00Z
updatedAt: 2024-01-02T12:00:00Z
name: Sample Session
description: This is a sample session description.
startDate: 2024-02-01T10:00:00Z
endDate: 2024-02-01T11:00:00Z
tags:
- QA
- Workshop
rsvpCount: 150
type: MeetingEntry
visibility: published
thumbnailUrl: https://example.com/thumbnail.png
status: ok
security:
- ks: []
summary: Retrieves a list of all sessions of a specified event
tags: *a2
/api/v1/sessions/speakerList:
post:
operationId: speakerList
parameters: []
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/SpeakerListRequestDto"
responses:
"200":
description: List of event session speakers
content:
application/json:
schema:
$ref: "#/components/schemas/SpeakerListResponseDto"
example:
speakers:
- id: speaker_12345
email: john@company.com
order: 1
isHidden: false
firstName: John
lastName: Doe
profileLink: https://company.com/johndoe
title: Senior Developer
bio: John has over 10 years of experience in software development.
thumbnailUrl: https://example.com/speaker_thumbnail.png
status: ok
security:
- ks: []
summary: Retrieves a list of an event session speakers
tags: *a2
/api/v1/team-members/create:
post:
operationId: create
parameters: []
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/CreateTeamRequestDto"
responses:
"200":
description: Created team member
content:
application/json:
schema:
$ref: "#/components/schemas/CreateTeamResponseDto"
example:
status: ok
teamMember:
id: user_123456
firstName: John
lastName: Doe
email: john@example.com
disabled: false
security:
- ks: []
summary: Creates a new Event Platform team member
tags: &a3
- Team members
/api/v1/team-members/update:
post:
operationId: update
parameters: []
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/UpdateTeamRequestDto"
responses:
"200":
description: Updated team member
content:
application/json:
schema:
$ref: "#/components/schemas/UpdateTeamResponseDto"
example:
status: ok
teamMember:
id: user_123456
firstName: John
lastName: Doe
email: john@example.com
disabled: false
security:
- ks: []
summary: Updates an Event Platform team member
tags: *a3
/api/v1/team-members/delete:
post:
operationId: delete
parameters: []
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/DeleteTeamRequestDto"
responses:
"200":
description: Deleted team member
content:
application/json:
schema:
$ref: "#/components/schemas/DeleteTeamResponseDto"
example:
status: ok
security:
- ks: []
summary: Deletes an Event Platform team member
tags: *a3
/api/v1/team-members/list:
post:
operationId: list
parameters: []
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/ListTeamRequestDto"
responses:
"200":
description: List of team members
content:
application/json:
schema:
$ref: "#/components/schemas/ListTeamResponseDto"
example:
totalCount: 1
status: ok
teamMembers:
- id: user_123456
firstName: John
lastName: Doe
email: john@example.com
disabled: false
security:
- ks: []
summary: Retrieves a list of Event Platform team members
tags: *a3
/api/v1/event-users/invite:
post:
operationId: invite
parameters: []
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/InviteEventUserRequestDto"
responses:
"200":
description: User invited successfully
content:
application/json:
schema:
$ref: "#/components/schemas/InviteEventUserResponseDto"
example:
user:
id: 1ef91ea60970881d430d4c6658eb8dba12a25e6083037b594a1871d129dd32b9
firstName: Jane
lastName: Doe
email: jane@example.com
title: VP Engineering
company: Acme Corp
bio: Speaker bio text
roles:
- Speaker
thumbnailUrl: https://cdn.kaltura.com/p/999/thumbnail/entry_id/1_p9ek1ngh/height/173/width/173
createdAt: 2025-01-01T10:00:00.000Z
updatedAt: 2025-01-02T10:00:00.000Z
status: Invited
status: ok
security:
- ks: []
summary: Invites a user to the event with the specified roles and profile data
tags: &a4
- Event Users
/api/v1/event-users/list:
post:
operationId: list
parameters: []
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/ListEventUserRequestDto"
responses:
"200":
description: List of event users
content:
application/json:
schema:
$ref: "#/components/schemas/ListEventUserResponseDto"
example:
users:
- id: 1ef91ea60970881d430d4c6658eb8dba12a25e6083037b594a1871d129dd32b9
firstName: Jane
lastName: Doe
email: jane@example.com
title: VP Engineering
company: Acme Corp
bio: Speaker bio text
roles:
- Speaker
thumbnailUrl: https://cdn.kaltura.com/p/999/thumbnail/entry_id/1_p9ek1ngh/height/173/width/173
createdAt: 2025-01-01T10:00:00.000Z
updatedAt: 2025-01-02T10:00:00.000Z
status: Invited
totalCount: 1
status: ok
security:
- ks: []
summary: Returns a paginated list of event users with optional filtering and
sorting
tags: *a4
/api/v1/event-users/update:
post:
operationId: update
parameters: []
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/UpdateEventUserRequestDto"
responses:
"200":
description: User updated successfully
content:
application/json:
schema:
$ref: "#/components/schemas/UpdateEventUserResponseDto"
example:
user:
id: 1ef91ea60970881d430d4c6658eb8dba12a25e6083037b594a1871d129dd32b9
firstName: Jane
lastName: Doe
email: jane@example.com
title: VP Engineering
company: Acme Corp
bio: Speaker bio text
roles:
- Speaker
thumbnailUrl: https://cdn.kaltura.com/p/999/thumbnail/entry_id/1_p9ek1ngh/height/173/width/173
createdAt: 2025-01-01T10:00:00.000Z
updatedAt: 2025-01-02T10:00:00.000Z
status: Invited
status: ok
security:
- ks: []
summary: Updates an event user profile and roles (role updates are additive only)
tags: *a4
/api/v1/event-users/delete:
post:
operationId: delete
parameters: []
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/DeleteEventUserRequestDto"
responses:
"200":
description: User removed from event
content:
application/json:
schema:
$ref: "#/components/schemas/DeleteEventUserResponseDto"
example:
status: ok
security:
- ks: []
summary: Removes a user from the event context including their session roles and
groups
tags: *a4
/api/v1/session-participants/add:
post:
operationId: add
parameters: []
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/AddSessionParticipantsRequestDto"
examples:
example:
value:
eventId: 98765
sessionId: 0_syswy6uj
speakers:
- userId: 1ef91ea60970881d430d4c6658eb8dba12a25e6083037b594a1871d129dd32b9
order: 1
isHidden: false
role: advancedSpeaker
- userId: abc123def456abc123def456abc123def456abc123def456abc123def456abc1
order: 2
isHidden: false
role: simpleSpeaker
moderatorIds:
- def789abc012def789abc012def789abc012def789abc012def789abc012def7
responses:
"200":
description: Participants added
content:
application/json:
schema:
$ref: "#/components/schemas/AddSessionParticipantsResponseDto"
example:
status: ok
security:
- ks: []
summary: Adds speakers and/or moderators to a session (users must have
event-level Speaker/Moderator role)
tags: &a5
- Session Participants
/api/v1/session-participants/remove:
post:
operationId: remove
parameters: []
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/RemoveSessionParticipantsRequestDto"
responses:
"200":
description: Participants removed
content:
application/json:
schema:
$ref: "#/components/schemas/RemoveSessionParticipantsResponseDto"
example:
status: ok
security:
- ks: []
summary: Removes speakers and/or moderators from a session
tags: *a5
/api/v1/session-participants/update:
post:
operationId: update
parameters: []
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/UpdateSessionParticipantsRequestDto"
examples:
example:
value:
eventId: 98765
sessionId: 0_syswy6uj
speakers:
- userId: 1ef91ea60970881d430d4c6658eb8dba12a25e6083037b594a1871d129dd32b9
role: advancedSpeaker
- userId: abc123def456abc123def456abc123def456abc123def456abc123def456abc1
order: 2
isHidden: false
responses:
"200":
description: Participants updated
content:
application/json:
schema:
$ref: "#/components/schemas/UpdateSessionParticipantsResponseDto"
example:
status: ok
security:
- ks: []
summary: Updates properties of speakers already assigned to a session (role,
order, visibility)
tags: *a5
/api/v1/session-participants/list:
post:
operationId: list
parameters: []
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/ListSessionParticipantsRequestDto"
responses:
"200":
description: Session participants
content:
application/json:
schema:
$ref: "#/components/schemas/ListSessionParticipantsResponseDto"
example:
speakers:
- id: 1ef91ea60970881d430d4c6658eb8dba12a25e6083037b594a1871d129dd32b9
firstName: Jane
lastName: Doe
email: jane@example.com
title: VP Engineering
bio: Speaker bio
thumbnailUrl: https://cdn.kaltura.com/thumbnail.jpg
type: speaker
order: 1
isHidden: false
sessionRole: simpleSpeaker
moderators:
- id: abc123def456abc123def456abc123def456abc123def456abc123def456abc1
firstName: John
lastName: Smith
email: john@example.com
type: moderator
status: ok
security:
- ks: []
summary: Lists all speakers and moderators for a session
tags: *a5
/metrics:
get:
operationId: index
parameters: []
responses:
"200":
description: ""
tags:
- Prometheus
info:
title: Kaltura Event Platform 🌍 Public API
description: ""
version: 1.1.2
contact: {}
tags:
- name: Events
description: 🎉 Event Management
- name: Team members
description: 👥 Event Platform Team Members
- name: Sessions
description: 🕒 Event Sessions
servers:
- url: http://localhost:3001
- url: https://events-api.nvq2.ovp
- url: https://events-api.nvp1.ovp.kaltura.com
- url: https://events-api.irp2.ovp.kaltura.com
- url: https://events-api.frp2.ovp.kaltura.com
components:
securitySchemes:
ks:
scheme: bearer
bearerFormat: JWT
type: http
schemas:
CreateEventRequestDto:
type: object
properties:
templateId:
type: string
description: Kaltura Event Template ID
example: 507f1f77bcf86cd799439011
name:
type: string
description: Event Name
example: Virtual Townhall 2025
description:
type: string
description: Event Description
example: Annual company-wide update
startDate:
type: string
description: Event Start Date
example: 2025-05-01T14:00:00Z
endDate:
type: string
description: Event End Date
example: 2025-05-01T16:00:00Z
timezone:
type: string
description: Event Timezone
example: America/New_York
required:
- templateId
- name
- startDate
- endDate
- timezone
PublicEventDto:
type: object
properties:
id:
type: number
description: Unique identifier for the event
publicDomain:
type: string
description: Public domain of the event
name:
type: string
description: Name of the event
description:
type: string
description: Description of the event
startDate:
type: string
description: Start date of the event (ISO string)
endDate:
type: string
description: End date of the event (ISO string)
timezone:
type: string
description: Timezone of the event
logoUrl:
type: string
description: URL of the event logo
bannerImageUrl:
type: string
description: URL of the event banner image
labels:
description: Labels associated with the event
type: array
items:
type: string
createdAt:
type: string
description: Creation timestamp (ISO string)
updatedAt:
type: string
description: Last update timestamp (ISO string)
languages:
description: Supported languages for the event
type: array
items:
type: string
isRegistrationOpen:
type: boolean
description: Indicates if registration is open
doorsOpenDate:
type: string
description: Date when doors open (ISO string)
templateId:
type: string
description: Template ID used for the event, custom or preset
templateName:
type: string
description: Template description for the event
required:
- id
- publicDomain
- name
- description
- startDate
- endDate
- timezone
- logoUrl
- bannerImageUrl
- labels
- createdAt
- updatedAt
- languages
- isRegistrationOpen
- doorsOpenDate
- templateId
- templateName
CreateEventResponseDto:
type: object
properties:
event:
description: Created event details
example: &a6
id: 1
publicDomain: example.com
name: Sample Event
description: This is a sample event description.
startDate: 2023-10-01T00:00:00Z
endDate: 2023-10-02T00:00:00Z
timezone: UTC
logoUrl: https://example.com/logo.png
bannerImageUrl: https://example.com/banner.png
labels:
- label1
- label2
createdAt: 2023-09-01T00:00:00Z
updatedAt: 2023-09-02T00:00:00Z
languages:
- en
- fr
isRegistrationOpen: true
doorsOpenDate: 2023-10-01T08:00:00Z
templateId: tm1000
templateName: Interactive session
allOf:
- $ref: "#/components/schemas/PublicEventDto"
status:
type: string
description: Status of the request
enum:
- ok
- Forbidden
- InvalidArgument
- RateLimitReached
- OperationNotAllowed
- ResourceDoesNotExist
- NEW_LOGIN_REQUIRED
- MISSING_OTP
- AuthLoginMissingOrg
example: ok
required:
- event
- status
DeleteEventRequestDto:
type: object
properties:
id:
type: number
description: Event ID
example: 98765
required:
- id
DeleteEventResponseDto:
type: object
properties:
event:
description: Deleted event details
example: *a6
allOf:
- $ref: "#/components/schemas/PublicEventDto"
status:
type: string
description: Status of the request
enum:
- ok
- Forbidden
- InvalidArgument
- RateLimitReached
- OperationNotAllowed
- ResourceDoesNotExist
- NEW_LOGIN_REQUIRED
- MISSING_OTP
- AuthLoginMissingOrg
example: ok
required:
- event
- status
ListEventFilterDto:
type: object
properties:
idIn:
description: Filter for events with ids in the provided array
example:
- 98765
type: array
items:
type: number
templateIdIn:
description: Filter for events with template ids in the provided array (preset
or custom)
example:
- tm0000
- tm1000
- tm2000
- tm3000
- tm4000
- 62170c5af3d27e919f30b100
type: array
items:
type: string
searchTerm:
type: string
description: Filter for events including the search term provided (by Name)
example: townhall
endDateGreaterThanOrEqual:
format: date-time
type: string
description: Filter for events with end date greater than or equal to the
provided value
endDateLessOrEqualThan:
format: date-time
type: string