forked from NENA911/Logging-Service
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathloggingservice.yaml
1256 lines (1256 loc) · 35 KB
/
loggingservice.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: Logging Service
version: "1.0.1"
servers:
- url: https://api.example.com/Logging/v1
paths:
/LogEvents:
get:
tags:
- RetrieveLogEvents, ListLogEventsByEventTypeAndDateRange
summary: Retrieves LogEvents. Use limit and start parameters for pagination.
operationId: RetrieveLogEvents
parameters:
- name: limit
in: query
description: Maximum number of results to return
required: false
schema:
type: integer
format: int32
- name: start
in: query
description: First item in the page of results, as an ordinal 1-based integer
required: false
schema:
type: integer
format: int32
minimum: 1
- name: logEventType
in: query
description: LogEvent type
required: false
schema:
$ref: '#/components/schemas/LogEventType'
- name: startTime
in: query
description: Start time
required: false
schema:
type: string
format: date-time
example: '2020-03-10T11:00:01-05:00'
- name: endTime
in: query
description: End time
required: false
schema:
type: string
format: date-time
example: '2020-03-15T11:00:01-05:00'
responses:
'200':
description: LogEvents found
content:
application/json:
schema:
$ref: '#/components/schemas/LogEventContainerArray'
'404':
description: Not found
post:
tags:
- LogEvent
summary: Logs a new event into the Logging Service
operationId: LogEvent
requestBody:
description: LogEvent data to add (JWS using flattened JSON serialization)
content:
application/json:
schema:
$ref: 'i3-common.yaml#/components/schemas/Jws'
required: true
responses:
'201':
description: LogEvent successfully logged
content:
application/json:
schema:
type: string
description: logEventId of the new logEvent
'434':
description: Signature Verification Failure
'438':
description: Unacceptable Algorithm
'454':
description: Unspecified Error
'460':
description: Bad LogEvent
'461':
description: LogEvent too big
'462':
description: LogEvent extension not on approved list
'463':
description: LogEvent extension on disallowed list
/LogEvents/{logEventId}:
get:
tags:
- RetrieveLogEvent
summary: Retrieves a LogEvent based on logEventId. LogEvent is returned in JWS using flattened JSON serialization
operationId: RetrieveLogEvent
parameters:
- name: logEventId
in: path
description: ID of the logEvent
required: true
schema:
type: string
responses:
'200':
description: LogEvent found
content:
application/json:
schema:
$ref: 'i3-common.yaml#/components/schemas/Jws'
'404':
description: Not found
/Conversations:
get:
tags:
- RetrieveConversationText
summary: Returns an HTML formatted record suitable for human consumption of the text portion of a call, including all text sent by all parties.
operationId: RetrieveConversationText
parameters:
- name: callId
in: query
description: Call ID of the call
required: true
schema:
type: string
responses:
'200':
description: Conversation found
content:
application/json:
schema:
type: string
'404':
description: Not found
'454':
description: Unspecified Error
'464':
description: No Text in this Call
/LogEventIds:
get:
tags:
- ListLogEventsByCallId, ListLogEventsByIncidentId
summary: Retrieves LogEvents IDs. Use limit and start parameters for pagination.
operationId: ListLogEventsById
parameters:
- name: limit
in: query
description: Maximum number of results to return
required: false
schema:
type: integer
format: int32
- name: start
in: query
description: First item in the page of results, as an ordinal 1-based integer
required: false
schema:
type: integer
format: int32
minimum: 1
- name: callId
in: query
description: Call ID of the call
required: false
schema:
type: string
- name: incidentId
in: query
description: Incident ID of the call
required: false
schema:
type: string
responses:
'200':
description: LogEvents found
content:
application/json:
schema:
$ref: '#/components/schemas/LogEventIdArray'
'404':
description: Not found
'454':
description: Unspecified Error
/CallIds:
get:
tags:
- ListCallsByIncidentId, ListCallsByDateRange, ListCallsByLocation
summary: Returns a list of Call Identifiers associated with a specific Incident Tracking Identifier, occurred within a time range or within a specified geographic region.
operationId: ListCalls
parameters:
- name: limit
in: query
description: Maximum number of results to return
required: false
schema:
type: integer
format: int32
- name: start
in: query
description: First item in the page of results, as an ordinal 1-based integer
required: false
schema:
type: integer
format: int32
minimum: 1
- name: incidentId
in: query
description: Incident ID of the call
required: false
schema:
type: string
- name: startTime
in: query
description: Start time
required: false
schema:
type: string
format: date-time
example: '2020-03-10T11:00:01-05:00'
- name: endTime
in: query
description: End time
required: false
schema:
type: string
format: date-time
example: '2020-03-15T11:00:01-05:00'
- name: area
in: query
description: Area of interest
required: false
schema:
type: string
responses:
'200':
description: Calls found
content:
application/json:
schema:
$ref: '#/components/schemas/CallIdArray'
'404':
description: Not found
'454':
description: Unspecified Error
'465':
description: Bad Timestamp
'466':
description: endTime occurs before startTime
'467':
description: Bad Geoshape
/IncidentIds:
get:
tags:
- ListIncidentsByDateRange, ListIncidentsByLocation
summary: Returns a list of Incident Tracking Identifiers occurring within a time/date range. Returns a list of Incidents that occurred within a specified geographic region.
operationId: ListIncidents
parameters:
- name: limit
in: query
description: Maximum number of results to return
required: false
schema:
type: integer
format: int32
- name: start
in: query
description: First item in the page of results, as an ordinal 1-based integer
required: false
schema:
type: integer
format: int32
minimum: 1
- name: startTime
in: query
description: Start time
required: false
schema:
type: string
format: date-time
example: '2020-03-10T11:00:01-05:00'
- name: endTime
in: query
description: End time
required: false
schema:
type: string
format: date-time
example: '2020-03-15T11:00:01-05:00'
- name: area
in: query
description: Area of interest
required: false
schema:
type: string
responses:
'200':
description: Incidents found
content:
application/json:
schema:
$ref: '#/components/schemas/IncidentIdArray'
'404':
description: Not found
'454':
description: Unspecified Error
'465':
description: Bad Timestamp
'466':
description: endTime occurs before startTime
'467':
description: Bad Geoshape
/AgencyIds:
get:
tags:
- ListAgenciesByCallId, ListAgenciesByIncidentId
summary: Returns a list of agencies involved in a Call or an Incident.
operationId: ListAgenciesById
parameters:
- name: limit
in: query
description: Maximum number of results to return
required: false
schema:
type: integer
format: int32
- name: start
in: query
description: First item in the page of results, as an ordinal 1-based integer
required: false
schema:
type: integer
format: int32
minimum: 1
- name: incidentId
in: query
description: Incident ID of the call
required: false
schema:
type: string
- name: callId
in: query
description: Incident ID of the call
required: false
schema:
type: string
responses:
'200':
description: Agencies found
content:
application/json:
schema:
$ref: '#/components/schemas/AgencyIdArray'
'404':
description: Not found
'454':
description: Unspecified Error
/Versions:
servers:
- url: https://api.example.com/Logging
description: Override base path for Versions query
get:
tags:
- RetrieveVersions
summary: Retrieves all supported versions, vendor parameter is optional.
operationId: RetrieveVersions
responses:
'200':
description: Versions found
content:
application/json:
schema:
$ref: 'i3-common.yaml#/components/schemas/VersionsArray'
components:
schemas:
LogEventContainerArray:
type: object
required:
- count
- totalCount
- logEventContainers
properties:
count:
type: integer
format: int32
description: Number of items in the array
totalCount:
type: integer
format: int32
description: Total number of items found
logEventContainers:
type: array
items:
$ref: '#/components/schemas/LogEventContainer'
description: Array of LogEvent Container objects
LogEventContainer:
type: object
required:
- logEventId
- logEvent
properties:
logEventId:
type: string
readOnly: true
rtsp:
type: array
items:
type: string
logEvent:
$ref: 'i3-common.yaml#/components/schemas/Jws'
LogEventIdArray:
type: object
required:
- count
- totalCount
- logEventIds
properties:
count:
type: integer
format: int32
description: Number of items in the array
totalCount:
type: integer
format: int32
description: Total number of items found
logEventIds:
type: array
items:
type: string
description: Array of LogEvent IDs
CallIdArray:
type: object
required:
- count
- totalCount
- callIds
properties:
count:
type: integer
format: int32
description: Number of items in the array
totalCount:
type: integer
format: int32
description: Total number of items found
callIds:
type: array
items:
type: string
description: Array of Call IDs
IncidentIdArray:
type: object
required:
- count
- totalCount
- incidentIds
properties:
count:
type: integer
format: int32
description: Number of items in the array
totalCount:
type: integer
format: int32
description: Total number of items found
logEventIds:
type: array
items:
type: string
description: Array of Incident IDs
AgencyIdArray:
type: object
required:
- count
- totalCount
- agencyIds
properties:
count:
type: integer
format: int32
description: Number of items in the array
totalCount:
type: integer
format: int32
description: Total number of items found
agencyIds:
type: array
items:
type: string
description: Array of Agency IDs
LogEventType:
type: string
enum: [CallProcessLogEvent, CallStartLogEvent, CallEndLogEvent, RecCallStartLogEvent, RecCallEndLogEvent, CallTransferLogEvent, RouteLogEvent, MediaStartLogEvent, MediaEndLogEvent, RecMediaStartLogEvent, RecMediaEndLogEvent,
RecordingFailedLogEvent, MessageLogEvent, AdditionalAgencyLogEvent, IncidentMergeLogEvent, IncidentUnMergeLogEvent, IncidentLinkLogEvent, IncidentUnLinkLogEvent, IncidentClearLogEvent, IncidentReopenLogEvent, LostQueryLogEvent,
LostResponseLogEvent, CallSignalingMessageLogEvent, SipRecMetadataLogEvent, NonRtpMediaMessageLogEvent, AliLocationQueryLogEvent, AliLocationResponseLogEvent, MalformedMessageLogEvent, IncidentSplitLogEvent, EidoLogEvent,
DiscrepancyReportLogEvent, ElementStateChangeLogEvent, ServiceStateChangeLogEvent, AdditionalDataQueryLogEvent, AdditionalDataResponseLogEvent, LocationQueryLogEvent, LocationResponseLogEvent, CallStateChangeLogEvent,
GatewayCallLogEvent, HookflashLogEvent, LegacyDigitsLogEvent, AgentStateChangeLogEvent, QueueStateChangeLogEvent, KeepAliveFailureLogEvent, RouteRuleMsgLogEvent, PolicyChangeLogEvent,
VersionsLogEvent, SubscribeLogEvent]
LogEvent:
type: object
required:
- logEventType
- timestamp
- agencyId
- elementId
properties:
clientAssignedIdentifier:
type: string
logEventType:
$ref: '#/components/schemas/LogEventType'
timestamp:
type: string
format: date-time
example: '2020-03-10T11:00:01-05:00'
elementId:
type: string
agencyId:
type: string
agencyAgentId:
type: string
agencyPositionId:
type: string
callId:
type: string
incidentId:
type: string
callIdSip:
type: string
ipAddressPort:
type: string
extension:
type: object
discriminator:
propertyName: logEventType
CallProcessLogEvent:
allOf:
- $ref: '#/components/schemas/LogEvent'
CallStartLogEvent:
allOf:
- $ref: '#/components/schemas/LogEvent'
- $ref: '#/components/schemas/CallLogEvent'
CallEndLogEvent:
allOf:
- $ref: '#/components/schemas/LogEvent'
- $ref: '#/components/schemas/CallLogEvent'
RecCallStartLogEvent:
allOf:
- $ref: '#/components/schemas/LogEvent'
- $ref: '#/components/schemas/CallLogEvent'
RecCallEndLogEvent:
allOf:
- $ref: '#/components/schemas/LogEvent'
- $ref: '#/components/schemas/CallLogEvent'
CallTransferLogEvent:
allOf:
- $ref: '#/components/schemas/LogEvent'
- type: object
required:
- target
- targetCallIdSip
properties:
target:
type: string
format: uri
targetCallIdSip:
type: string
RouteLogEvent:
allOf:
- $ref: '#/components/schemas/LogEvent'
- type: object
required:
- recipientUri
- ruleId
- policyOwner
- policyType
properties:
recipientUri:
type: string
format: uri
ruleId:
type: string
policyOwner:
type: string
policyType:
type: string
description: Values limited to those in the policyType registry
policyQueueName:
type: string
format: uri
policyId:
type: string
cause:
type: string
MediaStartLogEvent:
allOf:
- $ref: '#/components/schemas/LogEvent'
- type: object
required:
- sdp
- mediaLabal
- direction
properties:
sdp:
type: string
mediaLabel:
type: array
items:
type: string
direction:
$ref: '#/components/schemas/Direction'
MediaEndLogEvent:
allOf:
- $ref: '#/components/schemas/LogEvent'
- type: object
required:
- mediaLabel
properties:
mediaLabel:
type: array
items:
type: string
mediaQualityStats:
type: string
RecMediaStartLogEvent:
allOf:
- $ref: '#/components/schemas/LogEvent'
- type: object
required:
- sdp
- mediaLabel
properties:
sdp:
type: string
mediaLabel:
type: array
items:
type: string
direction:
$ref: '#/components/schemas/Direction'
mediaTranscodeFrom:
type: string
RecMediaEndLogEvent:
allOf:
- $ref: '#/components/schemas/LogEvent'
- type: object
required:
- mediaLabel
properties:
mediaLabel:
type: array
items:
type: string
mediaQualityStats:
type: string
mediaTranscodeFrom:
type: string
RecordingFailedLogEvent:
allOf:
- $ref: '#/components/schemas/LogEvent'
- type: object
required:
- sdp
- reasonCode
- reasonText
properties:
sdp:
type: string
reasonCode:
type: string
description: Values limited to those in the ReasonCode registry
reasonText:
type: string
MessageLogEvent:
allOf:
- $ref: '#/components/schemas/LogEvent'
- type: object
required:
- text
- direction
properties:
text:
type: string
direction:
$ref: '#/components/schemas/Direction'
AdditionalAgencyLogEvent:
allOf:
- $ref: '#/components/schemas/LogEvent'
- type: object
required:
- agencyId
properties:
agencyId:
type: string
IncidentMergeLogEvent:
allOf:
- $ref: '#/components/schemas/LogEvent'
- type: object
required:
- incidentId
- mergeIncidentId
properties:
incidentId:
type: string
mergeIncidentId:
type: string
IncidentUnMergeLogEvent:
allOf:
- $ref: '#/components/schemas/LogEvent'
- type: object
required:
- incidentId
- unmergedFromIncidentId
properties:
incidentId:
type: string
unmergedFromIncidentId:
type: string
IncidentLinkLogEvent:
allOf:
- $ref: '#/components/schemas/LogEvent'
- type: object
required:
- incidentId
- linkedIncidentId
- relationship
properties:
incidentId:
type: string
linkedIncidentId:
type: string
relationship:
type: string
enum: [parent, child, unspecified]
IncidentUnLinkLogEvent:
allOf:
- $ref: '#/components/schemas/LogEvent'
- type: object
required:
- incidentId
- unlinkedFromIncidentId
properties:
incidentId:
type: string
unlinkedFromIncidentId:
type: string
IncidentClearLogEvent:
allOf:
- $ref: '#/components/schemas/LogEvent'
IncidentReopenLogEvent:
allOf:
- $ref: '#/components/schemas/LogEvent'
LostQueryLogEvent:
allOf:
- $ref: '#/components/schemas/LogEvent'
- type: object
required:
- queryAdapter
- direction
- queryId
properties:
queryAdapter:
type: string
direction:
$ref: '#/components/schemas/Direction'
queryId:
type: string
malformedQuery:
type: string
LostResponseLogEvent:
allOf:
- $ref: '#/components/schemas/LogEvent'
- type: object
required:
- responseAdapter
- direction
- responseId
properties:
responseAdapter:
type: string
direction:
$ref: '#/components/schemas/Direction'
responseStatus:
type: string
responseId:
type: string
malformedResponse:
type: string
CallSignalingMessageLogEvent:
allOf:
- $ref: '#/components/schemas/LogEvent'
- type: object
required:
- text
- direction
properties:
text:
type: string
direction:
$ref: '#/components/schemas/Direction'
protocol:
type: string
SipRecMetadataLogEvent:
allOf:
- $ref: '#/components/schemas/LogEvent'
- type: object
required:
- text
properties:
text:
type: string
NonRtpMediaMessageLogEvent:
allOf:
- $ref: '#/components/schemas/LogEvent'
- type: object
required:
- text
- direction
properties:
text:
type: string
direction:
$ref: '#/components/schemas/Direction'
protocol:
type: string
AliLocationQueryLogEvent:
allOf:
- $ref: '#/components/schemas/LogEvent'
- type: object
required:
- text
- direction
- queryId
properties:
text:
type: string
direction:
$ref: '#/components/schemas/Direction'
queryId:
type: string
AliLocationResponseLogEvent:
allOf:
- $ref: '#/components/schemas/LogEvent'
- type: object
required:
- text
- direction
- responseId
properties:
text:
type: string
direction:
$ref: '#/components/schemas/Direction'
responseStatus:
type: string
description: Values limited to those in the Status Codes registry
responseId:
type: string
MalformedMessageLogEvent:
allOf:
- $ref: '#/components/schemas/LogEvent'
- type: object
required:
- text
- ipAddress
properties:
text:
type: string
ipAddress:
type: string
explanationText:
type: string
IncidentSplitLogEvent:
allOf:
- $ref: '#/components/schemas/LogEvent'
- type: object
required:
- incidentId
- type
properties:
incidentId:
type: string
type:
type: string
enum: [old, new]
EidoLogEvent:
allOf:
- $ref: '#/components/schemas/LogEvent'
- type: object
required:
- direction
properties:
body:
type: string
reference:
type: string
direction:
$ref: '#/components/schemas/Direction'
DiscrepancyReportLogEvent:
allOf:
- $ref: '#/components/schemas/LogEvent'
- type: object
required:
- contents
- direction
- type
properties:
contents:
type: string
direction:
$ref: '#/components/schemas/Direction'
type:
type: string
ElementStateChangeLogEvent:
allOf:
- $ref: '#/components/schemas/LogEvent'
- type: object
required:
- notificationContents
- direction
properties:
notificationContents:
type: string
affectedElementId:
type: string
direction:
$ref: '#/components/schemas/Direction'
ServiceStateChangeLogEvent:
allOf:
- $ref: '#/components/schemas/LogEvent'
- type: object
required:
- newState
- affectedServiceIdentifier
- direction
properties:
newState:
type: string
newSecurityPosture:
type: string
affectedServiceIdentifier:
type: string
direction:
$ref: '#/components/schemas/Direction'
AdditionalDataQueryLogEvent:
allOf:
- $ref: '#/components/schemas/LogEvent'
- type: object
required:
- uri
- text
- direction
- queryId
properties:
uri:
type: string
format: uri
text:
type: string
direction:
$ref: '#/components/schemas/Direction'
queryId:
type: string
AdditionalDataResponseLogEvent:
allOf:
- $ref: '#/components/schemas/LogEvent'
- type: object
required:
- text
- direction
- responseId
properties:
text:
type: string
direction:
$ref: '#/components/schemas/Direction'
responseStatus:
type: string
description: Values limited to those in the Status Codes registry
responseId:
type: string
LocationQueryLogEvent:
allOf:
- $ref: '#/components/schemas/LogEvent'
- type: object
required:
- uri
- text
- direction
- queryId
properties:
uri:
type: string
format: uri
text:
type: string
direction:
$ref: '#/components/schemas/Direction'