summaryrefslogtreecommitdiffstats
path: root/docs/files/VESEventListener.rst
blob: b79670f5d0b2ef4447bc9a22b55d072973a012b9 (plain)
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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
.. Copyright 2017 AT&T Intellectual Property, All rights reserved
.. Copyright 2017-2018 Huawei Technologies Co., Ltd.

===================================
Service: *VES Event Listener 5.4.1*
===================================

.. contents:: Table of Contents

Introduction
============

This document describes the RESTful interface for the VES (Virtual function Event Streaming) Event Listener. The VES Event Listener is capable of receiving any event sent in the VES Common Event Format. The Common Event Format is a JSON structure consisting of a required Common Event Header Block accompanied by zero or more event domain blocks. A JSON Schema of the VES Common Event Format is provided in Section 4 of this document.

It should be understood that events are well structured packages of information, identified by an eventName, which are asynchronously communicated to subscribers who are interested in the eventName. Events can convey measurements, faults, syslogs, threshold crossing alerts and others types of information. Events are simply a way of communicating well-structured packages of information to one or more instances of an Event Listener service.

This document describes a RESTful connectionless push event listener that is capable of receiving single events or batches of events in the Common Event Format. In future, additional documents may describe other transports which make use of persistent TCP connections for high volumes of streaming events.

Event Registration
------------------

All events must be compliant with the common event format, but specific events identified by their eventNames, may require that certain fields, which are optional in the common event format, be present when they are published. For example, a specific eventName may require that specific name-value pairs be present in the extensible structures provided within the Common Event Format.

Events are registered using an extensible YAML format (defined in a separate document), which specifies, for each eventName, the fields that are required, what field values may be sent, and any special handling that should be performed on those eventNames.

Naming Standards for eventName
------------------------------

To prevent naming collisions, eventNames sent as part of the
commonEventHeader, should conform to the following naming convention designed to summarize the purpose and type of the event, and to ensure the uniqueness of the eventName:

    {DomainAbbreviation}\_{SdcModel or
    ApplicationPlatform}\_{DescriptionOfInfoBeingConveyed}

Domain abbreviations are derived from the 'domain' field in the
commonEventHeader, as specified below:
-  'Fault'for the fault domain
-  'Heartbeat'for the heartbeat domain
-  'Mfvs'for the measurementsForVfScaling domain
-  'MobileFlow'for the mobileFlow domain
-  'Other'for the other domain
-  'SipSignaling'for the sipSignaling domain
-  'StateChange'for the stateChange domain
-  'Syslog'for the syslog domain
-  'Tca'for the thresholdCrossingAlert domain
-  'voiceQuality'for the voiceQuality domain

SDC (the ONAP Service Design and Creation environment) defines and catalogs specific services, VNFs, VF modules and other entities, which are generically referred to as 'SDC models'. The SDC model that an event is associated with should be indicated in the second subfield within the eventName. If the event is not associated with an Sdc model but is instead being generated by an application platform like SO, then a string identifying the  Application Platform may be used instead. In either case, all subfield names should be converted to camel case format (with no spaces, hyphens or underscores).

The final subfield of the eventName name should describe, in a compact camel case format (with no spaces, hyphens or underscores), the specific information being conveyed by the event. In some cases, this final subfield will not be required (e.g., in the case of Heartbeats or in the case of an event source which, for a domain like syslog, defines only one eventName to support it):

Examples of eventNames following the naming standards are provided below:

-  Fault\_MobileCallRecording\_PilotNumberPoolExhaustion
-  Heartbeat\_vIsbcMmc
-  Other\_WanBonding\_InstantiationPart1Complete
-  Syslog\_vDbe
-  Tca\_vDbe\_CpuThresholdExceeded
-  Other\_SO\_InstantiationPhase1Complete

Any questions about the naming of eventNames should be resolved as part of service and resource onboarding to the ONAP Service Design and Creation environment (i.e., SDC).

Support for Protocols Other Than HTTPS
--------------------------------------

This API specification describes an HTTPS RESTful interface using the JSON content-type.

Alternative specifications may be provided in future using Websockets, which would establish a permanent TCP socket, or Apache Avro which provides a binary format over an RPC protocol to be defined. Both would leverage the JSON schema provided in this document.

Versioning
----------

Three types of version numbers supported by this specification:
-  The API specification itself is versioned. Going forward, the major number of the specification version will be incremented whenever any change could break an existing client (e.g., a field name is deleted or changed). All other changes to the spec (e.g., a field name is added or text changes are made to the specification itself) will increment only the minor number. Note that the major number appears in REST resource URLs as v# (where '#'is the major number).

-  The JSON schema is versioned. Going forward, the major number of the JSON schema will be incremented whenever any change could break an existing client (e.g., a field name is deleted or changed). All other changes to the schema (e.g., a field name is added or text changes are made to the field descriptions) will increment only the minor number.

-  The field blocks are versioned. Field blocks include the commonEventHeader and the domain blocks (e.g., the faultFields block). Going forward, the major number of each field block will be incremented whenever any change to that block could break an existing client (e.g., a field name is deleted or changed). All other changes to that block (e.g., a field name is added or text changes are made to the field descriptions) will increment only the minor number.

Security
--------

Event sources must identify themselves to the VES Event Listener.

Event source credentials are passed using HTTP `Basic Authentication <http://tools.ietf.org/html/rfc2617>`__.

Credentials must not be passed on the query string. Credentials must be sent in an Authorization header as follows:

1. The username and password are formed into one string as "username:password"

2. The resulting string is Base64 encoded to produce the encoded credential.

3. The encoded credential is communicated in the header after the string "Authorization: Basic "

Because the credentials are merely encoded but not encrypted, HTTPS (rather than HTTP) should be used. HTTPS will also encrypt and protect event contents.

Examples are provided below.

Sample Request and Response
~~~~~~~~~~~~~~~~~~~~~~~~~~~

Sample Request
^^^^^^^^^^^^^^

 .. code:: bash

 	POST /eventListener/v5 HTTPS/1.1
 	Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
 	content-type: application/json
 	content-length: 12345
 	{
 	  "event": {
 		"commonEventHeader": {
 		  "version": 3.0,
 		  "domain": "heartbeat",
 		  "eventName": "Heartbeat\_vIsbcMmc",
 		  "eventId": "ab305d54-85b4-a31b-7db2fb6b9e546015",
 		  "sequence": 0,
 		  "priority": "Normal",
 		  "reportingEntityId": "cc305d54-75b4-431badb2eb6b9e541234",
 		  "reportingEntityName": "EricssonOamVf",
 		  "sourceId": "de305d54-75b4-431b-adb2-eb6b9e546014",
 		  "sourceName": "ibcx0001vm002ssc001",
 		  "nfNamingCode": "ibcx",
 		  "nfcNamingCode": "ssc",
 		  "startEpochMicrosec": 1413378172000000,
 		  "lastEpochMicrosec": 1413378172000000
 		 }
 	  }
 	}

Sample Success Response
^^^^^^^^^^^^^^^^^^^^^^^

 .. code:: bash

	HTTPS/1.1 202 Accepted

Resource Structure
==================

REST resources are defined with respect to a ServerRoot:

	ServerRoot = /{optionalRoutingtPath}

The resource structure is provided below:

	|image0|

Figure 1 REST Resource Structure

The {Domain} or FQDN above is typically provisioned into each
eventsource when it is instantiated. The {Port} above is typically 8443.

Common Event Format
===================

A JSON schema describing the Common Event Format is provided below and is reproduced in the tables that follow.

Common Event Datatypes
----------------------

Command List Processing Datatypes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Datatype: command
^^^^^^^^^^^^^^^^^

The command datatype is used by an event collector to request changes in the behavior of an event source (for more information, see 6.1.3); it consists of the following fields:

+-------------------------------------+------------------------------------+-------------+-----------------------------------------------------------------------------------------------------+
| Field                               | Type                               | Required?   | Description                                                                                         |
+=====================================+====================================+=============+=====================================================================================================+
| commandType                         | string                             | Yes         | Enumeration: 'heartbeatIntervalChange', 'measurementIntervalChange',                                |
|                                     |                                    |             |                                                                                                     |
|                                     |                                    |             | 'provideThrottlingState', 'throttllingSpecification'                                                |
+-------------------------------------+------------------------------------+-------------+-----------------------------------------------------------------------------------------------------+
| eventDomainThrottle Specification   | eventDomainThrottleSpecification   | No          | If commandType is 'throttlingSpecification', the fields to suppress within an event domain          |
+-------------------------------------+------------------------------------+-------------+-----------------------------------------------------------------------------------------------------+
| heartbeatInterval                   | integer                            | No          | If commandType is 'heartbeatIntervalChange', the heartbeatInterval duration to use in seconds       |
+-------------------------------------+------------------------------------+-------------+-----------------------------------------------------------------------------------------------------+
| measurementInterval                 | integer                            | No          | If commandType is 'measurementIntervalChange', the measurementInterval duration to use in seconds   |
+-------------------------------------+------------------------------------+-------------+-----------------------------------------------------------------------------------------------------+

Datatype: commandList
^^^^^^^^^^^^^^^^^^^^^

The commandList datatype is an array of commands from an event collector toward an event source; it consists of the following fields:

+---------------+---------------+-------------+-------------------------------------------------------------------+
| Field         | Type          | Required?   | Description                                                       |
+===============+===============+=============+===================================================================+
| commandList   | Command [ ]   | Yes         | List of commands from an event collector toward an event source   |
+---------------+---------------+-------------+-------------------------------------------------------------------+

Datatype: eventDomainThrottleSpecification
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The eventDomainThrottleSpecification datatype specifies what fields to suppress within an event domain; it consists of the following fields common to all events:

+-------------------------+-------------------------+-------------+-------------------------------------------------------------------------------------------------+
| Field                   | Type                    | Required?   | Description                                                                                     |
+=========================+=========================+=============+=================================================================================================+
| eventDomain             | string                  | Yes         | Event domain enum from the commonEventHeader domain field                                       |
+-------------------------+-------------------------+-------------+-------------------------------------------------------------------------------------------------+
| suppressedFieldNames    | string [ ]              | No          | List of optional field names in the event block that should not be sent to the Event Listener   |
+-------------------------+-------------------------+-------------+-------------------------------------------------------------------------------------------------+
| suppressedNvPairsList   | suppressedNvPairs [ ]   | No          | Optional list of specific NvPairsNames to suppress within a given Name-Value Field              |
+-------------------------+-------------------------+-------------+-------------------------------------------------------------------------------------------------+

Datatype: eventDomainThrottleSpecificationList
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The eventDomainThrottleSpecificationList datatype consists of the
following fields:

+----------------------------------------+----------------------------------------+-------------+----------------------------------------------+
| Field                                  | Type                                   | Required?   | Description                                  |
+========================================+========================================+=============+==============================================+
| eventDomainThrottleSpecificationList   | eventDomainThrottleSpecification [ ]   | Yes         | Array of eventDomainThrottleSpecifications   |
+----------------------------------------+----------------------------------------+-------------+----------------------------------------------+

Datatype: eventThrottlingState
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The eventThrottlingState datatype reports the throttling in force at the event source; it consists of the following fields:

+----------------------------------------+----------------------------------------+-------------+------------------------------------------------------------------------------------------------------------------------------+
| Field                                  | Type                                   | Required?   | Description                                                                                                                  |
+========================================+========================================+=============+==============================================================================================================================+
| eventThrottlingMode                    | string                                 | Yes         | Enumeration: 'normal', 'throttled'                                                                                           |
+----------------------------------------+----------------------------------------+-------------+------------------------------------------------------------------------------------------------------------------------------+
| eventDomainThrottleSpecificationList   | eventDomainThrottleSpecificationList   | No          | A list of eventDomainThrottleSpecifications currently in force at the event source, if the eventManagerMode is 'throttled'   |
+----------------------------------------+----------------------------------------+-------------+------------------------------------------------------------------------------------------------------------------------------+

Datatype: suppressedNvPairs
^^^^^^^^^^^^^^^^^^^^^^^^^^^

The suppressedNvPairs datatype is a list of specific NvPairsNames to suppress within a given Name-Value Field (for event throttling); it consists of the following fields:

+-------------------------+--------------+-------------+-------------------------------------------------------------------+
| Field                   | Type         | Required?   | Description                                                       |
+=========================+==============+=============+===================================================================+
| nvPairFieldName         | string       | Yes         | Name of the field within which are the nvpair names to suppress   |
+-------------------------+--------------+-------------+-------------------------------------------------------------------+
| suppressedNvPairNames   | string [ ]   | Yes         | Array of nvpair names to suppress (within the nvpairFieldName)    |
+-------------------------+--------------+-------------+-------------------------------------------------------------------+

Common Event Datatypes
~~~~~~~~~~~~~~~~~~~~~~

Datatype: event
^^^^^^^^^^^^^^^

The event datatype consists of the following fields which constitute the 'root level'of the common event format:

+----------------------------------+----------------------------------+-------------+------------------------------------------------------+
| Field                            | Type                             | Required?   | Description                                          |
+==================================+==================================+=============+======================================================+
| commonEventHeader                | commonEventHeader                | Yes         | Fields common to all events                          |
+----------------------------------+----------------------------------+-------------+------------------------------------------------------+
| faultFields                      | faultFields                      | No          | Fields specific to fault events                      |
+----------------------------------+----------------------------------+-------------+------------------------------------------------------+
| heartbeatFields                  | heartbeatFields                  | No          | Fields specific to heartbeat events                  |
+----------------------------------+----------------------------------+-------------+------------------------------------------------------+
| measurementsForVfScalingFields   | measurementsForVfScalingFields   | No          | Fields specific to measurementsForVfScaling events   |
+----------------------------------+----------------------------------+-------------+------------------------------------------------------+
| mobileFlowFields                 | mobileFlowFields                 | No          | Fields specific to mobility flow events              |
+----------------------------------+----------------------------------+-------------+------------------------------------------------------+
| otherFields                      | otherFields                      | No          | Fields specific to other types of events             |
+----------------------------------+----------------------------------+-------------+------------------------------------------------------+
| sipSignalingFields               | sipSignalingFields               | No          | Fields specific to sipSignaling events               |
+----------------------------------+----------------------------------+-------------+------------------------------------------------------+
| stateChangeFields                | stateChangeFields                | No          | Fields specific to state change events               |
+----------------------------------+----------------------------------+-------------+------------------------------------------------------+
| syslogFields                     | syslogFields                     | No          | Fields specific to syslog events                     |
+----------------------------------+----------------------------------+-------------+------------------------------------------------------+
| thresholdCrossingAlertFields     | thresholdCrossingAlertFields     | No          | Fields specific to threshold crossing alert events   |
+----------------------------------+----------------------------------+-------------+------------------------------------------------------+
| voiceQualityFields               | voiceQualityFields               | No          | Fields specific to voiceQuality events               |
+----------------------------------+----------------------------------+-------------+------------------------------------------------------+

Datatype: eventList
^^^^^^^^^^^^^^^^^^^

The eventList datatype consists of the following fields:

+-------------+-------------+-------------+-------------------+
| Field       | Type        | Required?   | Description       |
+=============+=============+=============+===================+
| eventList   | event [ ]   | Yes         | Array of events   |
+-------------+-------------+-------------+-------------------+

Datatype: field
^^^^^^^^^^^^^^^

The field datatype consists of the following fields:

+---------+----------+-------------+----------------------------+
| Field   | Type     | Required?   | Description                |
+=========+==========+=============+============================+
| name    | string   | Yes         | Name of the field          |
+---------+----------+-------------+----------------------------+
| value   | string   | Yes         | Value of the named field   |
+---------+----------+-------------+----------------------------+

Datatype: jsonObject
^^^^^^^^^^^^^^^^^^^^

The jsonObject datatype provides a json object schema, name and other meta-information along with one or more object instances that conform to the schema:

+--------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Field                    | Type                     | Required?   | Description                                                                                                                                                               |
+==========================+==========================+=============+===========================================================================================================================================================================+
| objectInstances          | JsonObjectInstance [ ]   | Yes         | Contains one or more instances of the json object                                                                                                                         |
+--------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| objectName               | string                   | Yes         | Name of the json object                                                                                                                                                   |
+--------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| objectSchema             | string                   | No          | json schema for the object                                                                                                                                                |
+--------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| objectSchemaUrl          | string                   | No          | URL to the json schema for the object                                                                                                                                     |
+--------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| nfSubscribedObjectName   | string                   | No          | Name of the object associated with the nfSubscriptionId                                                                                                                   |
+--------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| nfSubscriptionId         | string                   | No          | Identifies an openConfig telemetry subscription on a network function, which configures the network function to send complex object data associated with the jsonObject   |
+--------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Datatype: jsonObjectInstance
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The jsonObjectInstance datatype provides meta-information about an
instance of a jsonObject along with the actual object instance:

+-------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| Field                         | Type      | Required?   | Description                                                                                                                               |
+===============================+===========+=============+===========================================================================================================================================+
| objectInstance                | object    | Yes         | Contains an instance conforming to the jsonObject schema                                                                                  |
+-------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| objectInstanceEpochMicrosec   | number    | No          | the unix time, aka epoch time, associated with this objectInstance--as microseconds elapsed since 1 Jan 1970 not including leap seconds   |
+-------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| objectKeys                    | key [ ]   | No          | An ordered set of keys that identifies this particular instance of jsonObject (e.g., that places it in a hierarchy)                       |
+-------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------+

Datatype: key
^^^^^^^^^^^^^

The key datatype is a tuple which provides the name of a key along with
its value and relative order; it consists of the following fields:

+------------+-----------+-------------+----------------------------------------------------------------------+
| Field      | Type      | Required?   | Description                                                          |
+============+===========+=============+======================================================================+
| keyName    | string    | Yes         | Name of the key                                                      |
+------------+-----------+-------------+----------------------------------------------------------------------+
| keyOrder   | Integer   | No          | Relative sequence or order of the key (with respect to other keys)   |
+------------+-----------+-------------+----------------------------------------------------------------------+
| keyValue   | string    | No          | Value of the key                                                     |
+------------+-----------+-------------+----------------------------------------------------------------------+

Datatype: namedArrayOfFields
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The namedArrayOfFields datatype is an array of name value pairs along with a name for the array; it consists of the following fields:

+-----------------+-------------+-------------+------------------------------------------+
| Field           | Type        | Required?   | Description                              |
+=================+=============+=============+==========================================+
| name            | string      | Yes         | Name for the array of name-value pairs   |
+-----------------+-------------+-------------+------------------------------------------+
| arrayOfFields   | field [ ]   | Yes         | Name-value pairs                         |
+-----------------+-------------+-------------+------------------------------------------+

Datatype: requestError
^^^^^^^^^^^^^^^^^^^^^^

The requestError datatype defines the standard request error data
structure:

+-------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Field       | Type     | Required?   | Description                                                                                                                                                                                                                                                                                    |
+=============+==========+=============+================================================================================================================================================================================================================================================================================================+
| messageId   | string   | Yes         | Unique message identifier of the format 'ABCnnnn'where 'ABC'is either 'SVC'for Service Exceptions or 'POL'for Policy Exception. Exception numbers may be in the range of 0001 to 9999 where 0001 to 2999 are defined by OMA (see section 5.1) and 3000-9999 are available and undefined.       |
+-------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| text        | string   | Yes         | Message text, with replacement variables marked with %n, where n is an index into the list of <variables> elements, starting at 1                                                                                                                                                              |
+-------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| url         | string   | No          | Hyperlink to a detailed error resource e.g., an HTML page for browser user agents                                                                                                                                                                                                              |
+-------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| variables   | string   | No          | List of zero or more strings that represent the contents of the variables used by the message text                                                                                                                                                                                             |
+-------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Datatype: vendorVnfNameFields
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The vendorVnfNameFields provides vendor, vnf and vfModule identifying information:

+----------------+----------+-------------+---------------------------------------------------------------+
| Field          | Type     | Required?   | Description                                                   |
+================+==========+=============+===============================================================+
| vendorName     | string   | Yes         | VNF vendor name                                               |
+----------------+----------+-------------+---------------------------------------------------------------+
| vfModuleName   | string   | No          | The Sdc vfModuleName for the vfModule generating the event    |
+----------------+----------+-------------+---------------------------------------------------------------+
| vnfName        | string   | No          | The Sdc modelName for the VNF generating the event            |
+----------------+----------+-------------+---------------------------------------------------------------+

'Common Event Header'Datatypes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Datatype: commonEventHeader
^^^^^^^^^^^^^^^^^^^^^^^^^^^

The commonEventHeader datatype consists of the following fields common to all events:

+-------------------------+-------------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Field                   | Type                    | Required?   | Description                                                                                                                                                                                                                                                                    |
+=========================+=========================+=============+================================================================================================================================================================================================================================================================================+
| version                 | number                  | Yes         | Version of the event header (currently: 3.0)                                                                                                                                                                                                                                   |
+-------------------------+-------------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| eventName               | string                  | Yes         | Unique event name (see section 1 for more information)                                                                                                                                                                                                                         |
+-------------------------+-------------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| domain                  | string                  | Yes         | Event domain enumeration: 'fault', 'heartbeat', 'measurementsForVfScaling', 'mobileFlow', 'other', 'sipSignaling', 'stateChange', 'syslog', 'thresholdCrossingAlert', 'voiceQuality'                                                                                           |
+-------------------------+-------------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| eventId                 | string                  | Yes         | Event key that is unique to the event source                                                                                                                                                                                                                                   |
+-------------------------+-------------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| eventType               | string                  | No          | For example: 'applicationVnf', 'guestOS', 'hostOS', 'platform'                                                                                                                                                                                                                 |
+-------------------------+-------------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| nfcNamingCode           | string                  | No          | Network function component type: 3 characters (aligned with vfc naming standards)                                                                                                                                                                                              |
+-------------------------+-------------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| nfNamingCode            | string                  | No          | Network function type: 4 characters (aligned with vnf naming standards)                                                                                                                                                                                                        |
+-------------------------+-------------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| sourceId                | string                  | No          | UUID identifying the entity experiencing the event issue (note: the AT&T internal enrichment process shall ensure that this field is populated)                                                                                                                                |
+-------------------------+-------------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| sourceName              | string                  | Yes         | Name of the entity experiencing the event issue                                                                                                                                                                                                                                |
+-------------------------+-------------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| reportingEntityId       | string                  | No          | UUID identifying the entity reporting the event, for example an OAM VM (note: the AT&T internal enrichment process shall ensure that this field is populated)                                                                                                                  |
+-------------------------+-------------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| reportingEntityName     | string                  | Yes         | Name of the entity reporting the event, for example, an EMS name. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event.                                                                                   |
+-------------------------+-------------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| priority                | string                  | Yes         | Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low'                                                                                                                                                                                                             |
+-------------------------+-------------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| startEpochMicrosec      | number                  | Yes         | the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds                                                                                                                        |
+-------------------------+-------------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| lastEpochMicrosec       | number                  | Yes         | the latest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds                                                                                                                          |
+-------------------------+-------------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| sequence                | integer                 | Yes         | Ordering of events communicated by an event source instance (or 0 if not needed)                                                                                                                                                                                               |
+-------------------------+-------------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| internalHeader Fields   | internalHeader Fields   | No          | Fields (not supplied by event sources) that the VES Event Listener service can use to enrich the event if needed for efficient internal processing. This is an empty object which is intended to be defined separately by each provider implementing the VES Event Listener.   |
+-------------------------+-------------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Datatype: internalHeaderFields
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The internalHeaderFields datatype is an undefined object which can contain arbitrarily complex JSON structures. It is intended to be defined separately by each provider implementing the VES Event Listener.
The fields in internalHeaderFields are not provided by any event source but instead are added by the VES Event Listener service itself as part of an event enrichment process necessary for efficient internal processing of events received by the VES Event Listener:

Technology Independent Datatypes
--------------------------------

'Fault'Domain Datatypes
~~~~~~~~~~~~~~~~~~~~~~~~

Datatype: faultFields
^^^^^^^^^^^^^^^^^^^^^

The faultFields datatype consists of the following fields:

+-------------------------------+-------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Field                         | Type        | Required?   | Description                                                                                                                                                    |
+===============================+=============+=============+================================================================================================================================================================+
| faultFieldsVersion            | number      | Yes         | Version of the faultFields block (currently: 2.0)                                                                                                              |
+-------------------------------+-------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| eventSeverity                 | string      | Yes         | Event severity enumeration: 'CRITICAL', 'MAJOR', 'MINOR', 'WARNING', 'NORMAL'                                                                                  |
+-------------------------------+-------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| eventSourceType               | string      | Yes         | Examples: 'card', 'host', 'other', 'port', 'portThreshold', 'router', 'slotThreshold', 'switch', 'virtualMachine', 'virtualNetworkFunction'                    |
+-------------------------------+-------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| eventCategory                 | string      | No          | Event category, for example: 'license', 'link', 'routing', 'security', 'signaling'                                                                             |
+-------------------------------+-------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| alarmCondition                | string      | Yes         | Alarm condition reported by the device (e.g., 'tpLgCgiNotInConfig')                                                                                            |
+-------------------------------+-------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| specificProblem               | string      | Yes         | Short description of the alarm or problem (e.g., 'This event is sent when the LG is asked to perform a location for a CGI that is not in its configuration')   |
+-------------------------------+-------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| vfStatus                      | string      | Yes         | Virtual function status enumeration: 'Active', 'Idle', 'Preparing to terminate', 'Ready to terminate', 'Requesting Termination'                                |
+-------------------------------+-------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| alarmInterfaceA               | string      | No          | Card, port, channel or interface name of the device generating the alarm                                                                                       |
+-------------------------------+-------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| alarmAdditional Information   | field [ ]   | No          | Additional alarm information (note: for SNMP mapping to VES, for name use OID of varbind, for value use incoming data for that varbind)                        |
+-------------------------------+-------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+

'Heartbeat'Domain Datatypes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Datatype: heartbeatFields
^^^^^^^^^^^^^^^^^^^^^^^^^

The heartbeatFields datatype is an optional field block for fields specific to heartbeat events; it consists of the following fields:

+--------------------------+-------------+-------------+---------------------------------------------------------+
| Field                    | Type        | Required?   | Description                                             |
+==========================+=============+=============+=========================================================+
| heartbeatFieldsVersion   | number      | Yes         | Version of the heartbeatFields block (currently: 1.0)   |
+--------------------------+-------------+-------------+---------------------------------------------------------+
| additionalFields         | field [ ]   | No          | Additional expansion fields if needed                   |
+--------------------------+-------------+-------------+---------------------------------------------------------+
| heartbeatInterval        | Integer     | Yes         | Current heartbeatInterval in seconds                    |
+--------------------------+-------------+-------------+---------------------------------------------------------+

Measurements For VF Scaling'Domain Datatypes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Datatype: codecsInUse
^^^^^^^^^^^^^^^^^^^^^

The codecsInUse datatype consists of the following fields describing the number of times an identified codec was used over the measurementInterval:

+------------------+-----------+-------------+--------------------------------+
| Field            | Type      | Required?   | Description                    |
+==================+===========+=============+================================+
| codecIdentifer   | string    | Yes         | Description of the codec       |
+------------------+-----------+-------------+--------------------------------+
| numberInUse      | integer   | Yes         | Number of such codecs in use   |
+------------------+-----------+-------------+--------------------------------+

Datatype: cpuUsage
^^^^^^^^^^^^^^^^^^

The cpuUsage datatype defines the usage of an identifier CPU and
consists of the following fields:

+---------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+
| Field               | Type     | Required?   | Description                                                                                                                         |
+=====================+==========+=============+=====================================================================================================================================+
| cpuIdentifier       | string   | Yes         | CPU Identifier                                                                                                                      |
+---------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+
| cpuIdle             | number   | No          | Percentage of CPU time spent in the idle task                                                                                       |
+---------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+
| cpuUsageInterrupt   | number   | No          | Percentage of time spent servicing interrupts                                                                                       |
+---------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+
| cpuUsageNice        | number   | No          | Percentage of time spent running user space processes that have been niced                                                          |
+---------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+
| cpuUsageSoftIrq     | number   | No          | Percentage of time spent handling soft irq interrupts                                                                               |
+---------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+
| cpuUsageSteal       | number   | No          | Percentage of time spent in involuntary wait which is neither user, system or idle time and is effectively time that went missing   |
+---------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+
| cpuUsageSystem      | number   | No          | Percentage of time spent on system tasks running the kernel                                                                         |
+---------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+
| cpuUsageUser        | number   | No          | Percentage of time spent running un-niced user space processes                                                                      |
+---------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+
| cpuWait             | number   | No          | Percentage of CPU time spent waiting for I/O operations to complete                                                                 |
+---------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+
| percentUsage        | number   | Yes         | Aggregate cpu usage of the virtual machine on which the VNFC reporting the event is running                                         |
+---------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+

Datatype: diskUsage
^^^^^^^^^^^^^^^^^^^

The diskUsage datatype defines the usage of a disk and consists of the following fields:

+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Field                       | Type     | Required?   | Description                                                                                                                                                                                                                   |
+=============================+==========+=============+===============================================================================================================================================================================================================================+
| diskIdentifier              | string   | Yes         | Disk Identifier                                                                                                                                                                                                               |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskIoTimeAvg               | number   | No          | Milliseconds spent doing input/output operations over 1 sec; treat this metric as a device load percentage where 1000ms matches 100% load; provide the average over the measurement interval                                  |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskIoTimeLast              | number   | No          | Milliseconds spent doing input/output operations over 1 sec; treat this metric as a device load percentage where 1000ms matches 100% load; provide the last value measurement within the measurement interval                 |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskIoTimeMax               | number   | No          | Milliseconds spent doing input/output operations over 1 sec; treat this metric as a device load percentage where 1000ms matches 100% load; provide the maximum value measurement within the measurement interval              |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskIoTimeMin               | number   | No          | Milliseconds spent doing input/output operations over 1 sec; treat this metric as a device load percentage where 1000ms matches 100% load; provide the minimum value measurement within the measurement interval              |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskMergedReadAvg           | number   | No          | Number of logical read operations that were merged into physical read operations, e.g., two logical reads were served by one physical disk access; provide the average measurement within the measurement interval            |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskMergedReadLast          | number   | No          | Number of logical read operations that were merged into physical read operations, e.g., two logical reads were served by one physical disk access; provide the last value measurement within the measurement interval         |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskMergedReadMax           | number   | No          | Number of logical read operations that were merged into physical read operations, e.g., two logical reads were served by one physical disk access; provide the maximum value measurement within the measurement interval      |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskMergedReadMin           | number   | No          | Number of logical read operations that were merged into physical read operations, e.g., two logical reads were served by one physical disk access; provide the minimum value measurement within the measurement interval      |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskMergedWriteAvg          | number   | No          | Number of logical write operations that were merged into physical write operations, e.g., two logical writes were served by one physical disk access; provide the average measurement within the measurement interval         |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskMergedWriteLast         | number   | No          | Number of logical write operations that were merged into physical write operations, e.g., two logical writes were served by one physical disk access; provide the last value measurement within the measurement interval      |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskMergedWriteMax          | number   | No          | Number of logical write operations that were merged into physical write operations, e.g., two logical writes were served by one physical disk access; provide the maximum value measurement within the measurement interval   |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskMergedWriteMin          | number   | No          | Number of logical write operations that were merged into physical write operations, e.g., two logical writes were served by one physical disk access; provide the minimum value measurement within the measurement interval   |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskOctetsRead Avg          | number   | No          | Number of octets per second read from a disk or partition; provide the average measurement within the measurement interval                                                                                                    |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskOctetsRead Last         | number   | No          | Number of octets per second read from a disk or partition; provide the last measurement within the measurement interval                                                                                                       |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskOctetsRead Max          | number   | No          | Number of octets per second read from a disk or partition; provide the maximum measurement within the measurement interval                                                                                                    |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskOctetsRead Min          | number   | No          | Number of octets per second read from a disk or partition; provide the minimum measurement within the measurement interval                                                                                                    |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskOctetsWrite Avg         | number   | No          | Number of octets per second written to a disk or partition; provide the average measurement within the measurement interval                                                                                                   |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskOctetsWrite Last        | number   | No          | Number of octets per second written to a disk or partition; provide the last measurement within the measurement interval                                                                                                      |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskOctetsWriteMax          | number   | No          | Number of octets per second written to a disk or partition; provide the maximum measurement within the measurement interval                                                                                                   |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskOctetsWriteMin          | number   | No          | Number of octets per second written to a disk or partition; provide the minimum measurement within the measurement interval                                                                                                   |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskOpsReadAvg              | number   | No          | Number of read operations per second issued to the disk; provide the average measurement within the measurement interval                                                                                                      |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskOpsReadLast             | number   | No          | Number of read operations per second issued to the disk; provide the last measurement within the measurement interval                                                                                                         |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskOpsReadMax              | number   | No          | Number of read operations per second issued to the disk; provide the maximum measurement within the measurement interval                                                                                                      |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskOpsReadMin              | number   | No          | Number of read operations per second issued to the disk; provide the minimum measurement within the measurement interval                                                                                                      |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskOpsWriteAvg             | number   | No          | Number of write operations per second issued to the disk; provide the average measurement within the measurement interval                                                                                                     |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskOpsWriteLast            | number   | No          | Number of write operations per second issued to the disk; provide the last measurement within the measurement interval                                                                                                        |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskOpsWrite Max            | number   | No          | Number of write operations per second issued to the disk; provide the maximum measurement within the measurement interval                                                                                                     |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskOpsWriteMin             | number   | No          | Number of write operations per second issued to the disk; provide the minimum measurement within the measurement interval                                                                                                     |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskPendingOperationsAvg    | number   | No          | Queue size of pending I/O operations per second; provide the average measurement within the measurement interval                                                                                                              |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskPendingOperationsLast   | number   | No          | Queue size of pending I/O operations per second; provide the last measurement within the measurement interval                                                                                                                 |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskPendingOperationsMax    | number   | No          | Queue size of pending I/O operations per second; provide the maximum measurement within the measurement interval                                                                                                              |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskPendingOperationsMin    | number   | No          | Queue size of pending I/O operations per second; provide the minimum measurement within the measurement interval                                                                                                              |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskTimeReadAvg             | number   | No          | Milliseconds a read operation took to complete; provide the average measurement within the measurement interval                                                                                                               |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskTimeRead Last           | number   | No          | Milliseconds a read operation took to complete; provide the last measurement within the measurement interval                                                                                                                  |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskTimeRead Max            | number   | No          | Milliseconds a read operation took to complete; provide the maximum measurement within the measurement interval                                                                                                               |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskTimeRead Min            | number   | No          | Milliseconds a read operation took to complete; provide the minimum measurement within the measurement interval                                                                                                               |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskTimeWrite Avg           | number   | No          | Milliseconds a write operation took to complete; provide the average measurement within the measurement interval                                                                                                              |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskTimeWrite Last          | number   | No          | Milliseconds a write operation took to complete; provide the last measurement within the measurement interval                                                                                                                 |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskTimeWrite Max           | number   | No          | Milliseconds a write operation took to complete; provide the maximum measurement within the measurement interval                                                                                                              |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskTimeWrite Min           | number   | No          | Milliseconds a write operation took to complete; provide the minimum measurement within the measurement interval                                                                                                              |
+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Datatype: featuresInUse
^^^^^^^^^^^^^^^^^^^^^^^

The featuresInUse datatype consists of the following fields which
describe the number of times an identified feature was used over the measurementInterval:

+----------------------+-----------+-------------+---------------------------------------------------+
| Field                | Type      | Required?   | Description                                       |
+======================+===========+=============+===================================================+
| featureIdentifer     | string    | Yes         | Description of the feature                        |
+----------------------+-----------+-------------+---------------------------------------------------+
| featureUtilization   | integer   | Yes         | Number of times the identified feature was used   |
+----------------------+-----------+-------------+---------------------------------------------------+

Datatype: filesystemUsage
^^^^^^^^^^^^^^^^^^^^^^^^^

The filesystemUsage datatype consists of the following fields:

+-----------------------+----------+-------------+--------------------------------------------------------+
| Field                 | Type     | Required?   | Description                                            |
+=======================+==========+=============+========================================================+
| filesystemName        | string   | Yes         | File system name                                       |
+-----------------------+----------+-------------+--------------------------------------------------------+
| blockConfigured       | number   | Yes         | Configured block storage capacity in GB                |
+-----------------------+----------+-------------+--------------------------------------------------------+
| blockIops             | number   | Yes         | Block storage input-output operations per second       |
+-----------------------+----------+-------------+--------------------------------------------------------+
| blockUsed             | number   | Yes         | Used block storage capacity in GB                      |
+-----------------------+----------+-------------+--------------------------------------------------------+
| ephemeralConfigured   | number   | Yes         | Configured ephemeral storage capacity in GB            |
+-----------------------+----------+-------------+--------------------------------------------------------+
| ephemeralIops         | number   | Yes         | Ephemeral storage input-output operations per second   |
+-----------------------+----------+-------------+--------------------------------------------------------+
| ephemeralUsed         | number   | Yes         | Used ephemeral storage capacity in GB                  |
+-----------------------+----------+-------------+--------------------------------------------------------+

Datatype: latencyBucketMeasure
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The latencyBucketMeasure datatype consists of the following fields which describe the number of counts falling within a defined latency bucket:

+--------------------------+----------+-------------+------------------------------------------------------------+
| Field                    | Type     | Required?   | Description                                                |
+==========================+==========+=============+============================================================+
| countsInTheBucket        | number   | Yes         | Number of counts falling within a defined latency bucket   |
+--------------------------+----------+-------------+------------------------------------------------------------+
| highEndOfLatencyBucket   | number   | No          | High end of bucket range (typically in ms)                 |
+--------------------------+----------+-------------+------------------------------------------------------------+
| lowEndOfLatencyBucket    | number   | No          | Low end of bucket range (typically in ms)                  |
+--------------------------+----------+-------------+------------------------------------------------------------+

Datatype: measurementsForVfScalingFields
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The measurementsForVfScalingFields datatype consists of the following fields:

+-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Field                             | Type                       | Required?   | Description                                                                                                                                                                                               |
+===================================+============================+=============+===========================================================================================================================================================================================================+
| measurementsForVfScalingVersion   | number                     | Yes         | Version of the measurementsForVfScalingFields block (currently: 2.0)                                                                                                                                      |
+-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| additionalFields                  | field [ ]                  | No          | Additional measurement fields if needed                                                                                                                                                                   |
+-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| additionalMeasurements            | namedArrayOfFields [ ]     | No          | Array of named name-value-pair arrays if needed                                                                                                                                                           |
+-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| additionalObjects                 | jsonObject [ ]             | No          | Array of JSON objects described by name, schema and other meta-information, if needed                                                                                                                     |
+-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| codecUsageArray                   | codecsInUse []             | No          | Array of codecs in use                                                                                                                                                                                    |
+-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| concurrentSessions                | integer                    | No          | Peak concurrent sessions for the VM or VNF (depending on the context) over the measurementInterval                                                                                                        |
+-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| configuredEntities                | integer                    | No          | Depending on the context over the measurementInterval: peak total number of users, subscribers, devices, adjacencies, etc., for the VM, or peak total number of subscribers, devices, etc., for the VNF   |
+-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| cpuUsageArray                     | cpuUsage []                | No          | Usage of an array of CPUs                                                                                                                                                                                 |
+-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| diskUsageArray                    | diskUsage []               | No          | Usage of an array of disks                                                                                                                                                                                |
+-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| featureUsageArray                 | featuresInUse []           | No          | Array of features in use                                                                                                                                                                                  |
+-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| filesystemUsageArray              | filesystemUsage []         | No          | Filesystem usage of the VM on which the VNFC reporting the event is running                                                                                                                               |
+-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| latencyDistribution               | latencyBucketMeasure [ ]   | No          | Array of integers representing counts of requests whose latency in milliseconds falls within per-VNF configured ranges; where latency is the duration between a service request and its fulfillment.      |
+-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| meanRequestLatency                | number                     | No          | Mean seconds required to respond to each request for the VM on which the VNFC reporting the event is running                                                                                              |
+-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| measurementInterval               | number                     | Yes         | Interval over which measurements are being reported in seconds                                                                                                                                            |
+-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| memoryUsageArray                  | memoryUsage []             | No          | Memory usage of an array of VMs                                                                                                                                                                           |
+-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| numberOfMediaPortsInUse           | integer                    | No          | Number of media ports in use                                                                                                                                                                              |
+-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| requestRate                       | number                     | No          | Peak rate of service requests per second to the VNF over the measurementInterval                                                                                                                          |
+-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| vnfcScalingMetric                 | integer                    | No          | Represents busy-ness of the VNF from 0 to 100 as reported by the VNFC                                                                                                                                     |
+-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| vNicPerformanceArray              | vNicPerformance [ ]        | No          | Performance metrics of an array of virtual network interface cards                                                                                                                                        |
+-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Datatype: memoryUsage
^^^^^^^^^^^^^^^^^^^^^

The memoryUsage datatype defines the memory usage of a virtual machine and consists of the following fields:

+--------------------+----------+-------------+----------------------------------------------------------------------------------------------------------+
| Field              | Type     | Required?   | Description                                                                                              |
+====================+==========+=============+==========================================================================================================+
| memoryBuffered     | number   | No          | Kibibytes of temporary storage for raw disk blocks                                                       |
+--------------------+----------+-------------+----------------------------------------------------------------------------------------------------------+
| memoryCached       | number   | No          | Kibibytes of memory used for cache                                                                       |
+--------------------+----------+-------------+----------------------------------------------------------------------------------------------------------+
| memoryConfigured   | number   | No          | Kibibytes of memory configured in the virtual machine on which the VNFC reporting the event is running   |
+--------------------+----------+-------------+----------------------------------------------------------------------------------------------------------+
| memoryFree         | number   | Yes         | Kibibytes of physical RAM left unused by the system                                                      |
+--------------------+----------+-------------+----------------------------------------------------------------------------------------------------------+
| memorySlabRecl     | number   | No          | The part of the slab that can be reclaimed such as caches measured in kibibytes                          |
+--------------------+----------+-------------+----------------------------------------------------------------------------------------------------------+
| memorySlabUnrecl   | number   | No          | The part of the slab that cannot be reclaimed even when lacking memory measure in kibibytes              |
+--------------------+----------+-------------+----------------------------------------------------------------------------------------------------------+
| memoryUsed         | number   | Yes         | Total memory minus the sum of free, buffered, cached and slab memory measured in kibibytes               |
+--------------------+----------+-------------+----------------------------------------------------------------------------------------------------------+
| vmIdentifier       | string   | Yes         | Virtual Machine identifier associated with the memory metrics                                            |
+--------------------+----------+-------------+----------------------------------------------------------------------------------------------------------+

Datatype: vNicPerformance
^^^^^^^^^^^^^^^^^^^^^^^^^

The vNicPerformance datatype consists of the following fields which describe the performance and errors of an of an identified virtual network interface card:

+------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
| Field                                    | Type     | Required?   | Description                                                                                                                                   |
+==========================================+==========+=============+===============================================================================================================================================+
| receivedBroadcastPacketsAccumulated      | number   | No          | Cumulative count of broadcast packets received as read at the end of the measurement interval                                                 |
+------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
| receivedBroadcastPacketsDelta            | number   | No          | Count of broadcast packets received within the measurement interval                                                                           |
+------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
| receivedDiscardedPacketsAccumulated      | number   | No          | Cumulative count of discarded packets received as read at the end of the measurement interval                                                 |
+------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
| receivedDiscardedPacketsDelta            | number   | No          | Count of discarded packets received within the measurement interval                                                                           |
+------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
| receivedErrorPacketsAccumulated          | number   | No          | Cumulative count of error packets received as read at the end of the measurement interval                                                     |
+------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
| receivedErrorPacketsDelta                | number   | No          | Count of error packets received within the measurement interval                                                                               |
+------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
| receivedMulticastPacketsAccumulated      | number   | No          | Cumulative count of multicast packets received as read at the end of the measurement interval                                                 |
+------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
| receivedMulticastPacketsDelta            | number   | No          | Count of multicast packets received within the measurement interval                                                                           |
+------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
| receivedOctetsAccumulated                | number   | No          | Cumulative count of octets received as read at the end of the measurement interval                                                            |
+------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
| receivedOctetsDelta                      | number   | No          | Count of octets received within the measurement interval                                                                                      |
+------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
| receivedTotalPacketsAccumulated          | number   | No          | Cumulative count of all packets received as read at the end of the measurement interval                                                       |
+------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
| receivedTotalPacketsDelta                | number   | No          | Count of all packets received within the measurement interval                                                                                 |
+------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
| receivedUnicastPacketsAccumulated        | number   | No          | Cumulative count of unicast packets received as read at the end of the measurement interval                                                   |
+------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
| receivedUnicastPacketsDelta              | number   | No          | Count of unicast packets received within the measurement interval                                                                             |
+------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
| transmittedBroadcastPacketsAccumulated   | number   | No          | Cumulative count of broadcast packets transmitted as read at the end of the measurement interval                                              |
+------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
| transmittedBroadcastPacketsDelta         | number   | No          | Count of broadcast packets transmitted within the measurement interval                                                                        |
+------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
| transmittedDiscardedPacketsAccumulated   | number   | No          | Cumulative count of discarded packets transmitted as read at the end of the measurement interval                                              |
+------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
| transmittedDiscardedPacketsDelta         | number   | No          | Count of discarded packets transmitted within the measurement interval                                                                        |
+------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
| transmittedErrorPacketsAccumulated       | number   | No          | Cumulative count of error packets transmitted as read at the end of the measurement interval                                                  |
+------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
| transmittedErrorPacketsDelta             | number   | No          | Count of error packets transmitted within the measurement interval                                                                            |
+------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
| transmittedMulticastPacketsAccumulated   | number   | No          | Cumulative count of multicast packets transmitted as read at the end of the measurement interval                                              |
+------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
| transmittedMulticastPacketsDelta         | number   | No          | Count of multicast packets transmitted within the measurement interval                                                                        |
+------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
| transmittedOctetsAccumulated             | number   | No          | Cumulative count of octets transmitted as read at the end of the measurement interval                                                         |
+------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
| transmittedOctetsDelta                   | number   | No          | Count of octets transmitted within the measurement interval                                                                                   |
+------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
| transmittedTotalPacketsAccumulated       | number   | No          | Cumulative count of all packets transmitted as read at the end of the measurement interval                                                    |
+------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
| transmittedTotalPacketsDelta             | number   | No          | Count of all packets transmitted within the measurement interval                                                                              |
+------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
| transmittedUnicastPacketsAccumulated     | number   | No          | Cumulative count of unicast packets transmitted as read at the end of the measurement interval                                                |
+------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
| transmittedUnicastPacketsDelta           | number   | No          | Count of unicast packets transmitted within the measurement interval                                                                          |
+------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
| valuesAreSuspect                         | string   | Yes         | Enumeration: 'true'or 'false'. If 'true'then the vNicPerformance values are likely inaccurate due to counter overflow or other condtions.     |
+------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
| vNicIdentifier                           | string   | Yes         | vNic identification                                                                                                                           |
+------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+

'Other'Domain Datatypes
~~~~~~~~~~~~~~~~~~~~~~~~

Datatype: otherFields
^^^^^^^^^^^^^^^^^^^^^

The otherFields datatype defines fields for events belonging to the 'other' domain of the commonEventHeader domain enumeration; it consists of the following fields:

+-----------------------------+--------------------------+-------------+------------------------------------------------------------------------------+
| Field                       | Type                     | Required?   | Description                                                                  |
+=============================+==========================+=============+==============================================================================+
| otherFieldsVersion          | number                   | Yes         | Version of the otherFields block (currently: 1.1)                            |
+-----------------------------+--------------------------+-------------+------------------------------------------------------------------------------+
| hashOfNameValuePairArrays   | namedArrayOfFields [ ]   | No          | Array of named name-value-pair arrays                                        |
+-----------------------------+--------------------------+-------------+------------------------------------------------------------------------------+
| jsonObjects                 | jsonObject [ ]           | No          | Array of JSON objects described by name, schema and other meta-information   |
+-----------------------------+--------------------------+-------------+------------------------------------------------------------------------------+
| nameValuePairs              | field [ ]                | No          | Array of name-value pairs                                                    |
+-----------------------------+--------------------------+-------------+------------------------------------------------------------------------------+

'State Change'Domain Datatypes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Datatype: stateChangeFields
^^^^^^^^^^^^^^^^^^^^^^^^^^^

The stateChangeFields datatype consists of the following fields:

+----------------------------+-------------+-------------+----------------------------------------------------------------------------+
| Field                      | Type        | Required?   | Description                                                                |
+============================+=============+=============+============================================================================+
| stateChangeFieldsVersion   | number      | Yes         | Version of the stateChangeFields block (currently: 2.0)                    |
+----------------------------+-------------+-------------+----------------------------------------------------------------------------+
| additionalFields           | field [ ]   | No          | Additional stateChange fields if needed                                    |
+----------------------------+-------------+-------------+----------------------------------------------------------------------------+
| newState                   | string      | Yes         | New state of the entity: 'inService', 'maintenance', 'outOfService'        |
+----------------------------+-------------+-------------+----------------------------------------------------------------------------+
| oldState                   | string      | Yes         | Previous state of the entity: 'inService', 'maintenance', 'outOfService'   |
+----------------------------+-------------+-------------+----------------------------------------------------------------------------+
| stateInterface             | string      | Yes         | Card or port name of the entity that changed state                         |
+----------------------------+-------------+-------------+----------------------------------------------------------------------------+

'Syslog'Domain Datatypes
~~~~~~~~~~~~~~~~~~~~~~~~~

Datatype: syslogFields
^^^^^^^^^^^^^^^^^^^^^^

The syslogFields datatype consists of the following fields:

+-----------------------+-----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
| Field                 | Type      | Required?   | Description                                                                                                                                   |
+=======================+===========+=============+===============================================================================================================================================+
| syslogFieldsVersion   | number    | Yes         | Version of the syslogFields block (currently: 3.0)                                                                                            |
+-----------------------+-----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
| additionalFields      | string    | No          | Additional syslog fields if needed, provided as name=value delimited by a pipe '\|'symbol, for example: "name1=value1\|name2=value2\|""       |
+-----------------------+-----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
| eventSourceHost       | string    | No          | Hostname of the device                                                                                                                        |
+-----------------------+-----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
| eventSourceType       | string    | Yes         | Examples: 'other', 'router', 'switch', 'host', 'card', 'port', 'slotThreshold', 'portThreshold', 'virtualMachine', 'virtualNetworkFunction'   |
+-----------------------+-----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
| syslogFacility        | integer   | No          | Numeric code from 0 to 23 for facility:                                                                                                       |
|                       |           |             |                                                                                                                                               |
|                       |           |             | 0 kernel messages                                                                                                                             |
|                       |           |             |                                                                                                                                               |
|                       |           |             | 1 user-level messages                                                                                                                         |
|                       |           |             |                                                                                                                                               |
|                       |           |             | 2 mail system                                                                                                                                 |
|                       |           |             |                                                                                                                                               |
|                       |           |             | 3 system daemons                                                                                                                              |
|                       |           |             |                                                                                                                                               |
|                       |           |             | 4 security/authorization messages                                                                                                             |
|                       |           |             |                                                                                                                                               |
|                       |           |             | 5 messages generated internally by syslogd                                                                                                    |
|                       |           |             |                                                                                                                                               |
|                       |           |             | 6 line printer subsystem                                                                                                                      |
|                       |           |             |                                                                                                                                               |
|                       |           |             | 7 network news subsystem                                                                                                                      |
|                       |           |             |                                                                                                                                               |
|                       |           |             | 8 UUCP subsystem                                                                                                                              |
|                       |           |             |                                                                                                                                               |
|                       |           |             | 9 clock daemon                                                                                                                                |
|                       |           |             |                                                                                                                                               |
|                       |           |             | 10 security/authorization messages                                                                                                            |
|                       |           |             |                                                                                                                                               |
|                       |           |             | 11 FTP daemon                                                                                                                                 |
|                       |           |             |                                                                                                                                               |
|                       |           |             | 12 NTP subsystem                                                                                                                              |
|                       |           |             |                                                                                                                                               |
|                       |           |             | 13 log audit                                                                                                                                  |
|                       |           |             |                                                                                                                                               |
|                       |           |             | 14 log alert                                                                                                                                  |
|                       |           |             |                                                                                                                                               |
|                       |           |             | 15 clock daemon (note 2)                                                                                                                      |
|                       |           |             |                                                                                                                                               |
|                       |           |             | 16 local use 0 (local0)                                                                                                                       |
|                       |           |             |                                                                                                                                               |
|                       |           |             | 17 local use 1 (local1)                                                                                                                       |
|                       |           |             |                                                                                                                                               |
|                       |           |             | 18 local use 2 (local2)                                                                                                                       |
|                       |           |             |                                                                                                                                               |
|                       |           |             | 19 local use 3 (local3)                                                                                                                       |
|                       |           |             |                                                                                                                                               |
|                       |           |             | 20 local use 4 (local4)                                                                                                                       |
|                       |           |             |                                                                                                                                               |
|                       |           |             | 21 local use 5 (local5)                                                                                                                       |
|                       |           |             |                                                                                                                                               |
|                       |           |             | 22 local use 6 (local6)                                                                                                                       |
|                       |           |             |                                                                                                                                               |
|                       |           |             | 23 local use 7 (local7 )                                                                                                                      |
+-----------------------+-----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
| syslogMsg             | string    | Yes         | Syslog message                                                                                                                                |
+-----------------------+-----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
| syslogPri             | integer   | No          | 0-192                                                                                                                                         |
|                       |           |             |                                                                                                                                               |
|                       |           |             | Combined Severity and Facility                                                                                                                |
+-----------------------+-----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
| syslogProc            | string    | No          | Identifies the application that originated the message                                                                                        |
+-----------------------+-----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
| syslogProcId          | number    | No          | A change in the value of this field indicates a discontinuity in syslog reporting                                                             |
+-----------------------+-----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
| syslogSData           | string    | No          | Syslog structured data consisting of a structured data Id followed by a set of key value pairs (see below for an example)                     |
|                       |           |             |                                                                                                                                               |
|                       |           |             | \*\*Note: SD-ID may not be present if syslogSdId is populated                                                                                 |
+-----------------------+-----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
| syslogSdId            | string    | No          | 0-32 char in format name@number,                                                                                                              |
|                       |           |             |                                                                                                                                               |
|                       |           |             | i.e., ourSDID@32473                                                                                                                           |
+-----------------------+-----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
| syslogSev             | string    | No          | Level-of-severity enumeration in quotes below:                                                                                                |
|                       |           |             |                                                                                                                                               |
|                       |           |             | 'Emergency': system is unusable                                                                                                               |
|                       |           |             |                                                                                                                                               |
|                       |           |             | 'Alert': action must be taken immediately                                                                                                     |
|                       |           |             |                                                                                                                                               |
|                       |           |             | 'Critical': critical conditions                                                                                                               |
|                       |           |             |                                                                                                                                               |
|                       |           |             | 'Error': error conditions                                                                                                                     |
|                       |           |             |                                                                                                                                               |
|                       |           |             | 'Warning': warning conditions                                                                                                                 |
|                       |           |             |                                                                                                                                               |
|                       |           |             | 'Notice': normal but significant condition                                                                                                    |
|                       |           |             |                                                                                                                                               |
|                       |           |             | 'Info': Informational: informational messages                                                                                                 |
|                       |           |             |                                                                                                                                               |
|                       |           |             | 'Debug': debug-level messages                                                                                                                 |
+-----------------------+-----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
| syslogTag             | string    | Yes         | MsgId indicating the type of message such as 'TCPOUT'or 'TCPIN'; 'NILVALUE'should be used when no other value can be provided                 |
+-----------------------+-----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
| syslogVer             | number    | No          | IANA assigned version of the syslog protocol specification (typically '1')                                                                    |
+-----------------------+-----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+

Example of syslogSData:

    STRUCTURED-DATA = NILVALUE / 1\*SD-ELEMENT

    SD-ELEMENT = "[" SD-ID \*(SP SD-PARAM) "]"

    SD-PARAM = PARAM-NAME "=" %d34 PARAM-VALUE %d34

    SD-ID = SD-NAME

    PARAM-NAME = SD-NAME

    PARAM-VALUE = UTF-8-STRING ; characters '"', '\\' and

    ; ']' MUST be escaped.

    SD-NAME = 1\*32PRINTUSASCII

    ; except '=', SP, ']', %d34 (")

'Threshold Crossing Alert'Domain Datatypes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Datatype: counter
^^^^^^^^^^^^^^^^^

The counter datatype consists of the following fields:

+---------------------+----------+-------------+-----------------------------------+
| Field               | Type     | Required?   | Description                       |
+=====================+==========+=============+===================================+
| name                | string   | Yes         | Name of the counter               |
+---------------------+----------+-------------+-----------------------------------+
| value               | string   | Yes         | Current value of the counter      |
+---------------------+----------+-------------+-----------------------------------+
| threshholdCrossed   | string   | Yes         | Last threshold that was crossed   |
+---------------------+----------+-------------+-----------------------------------+
| criticality         | string   | Yes         | Enumeration: 'CRIT', 'MAJ'        |
+---------------------+----------+-------------+-----------------------------------+

Datatype: thresholdCrossingAlertFields
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The thresholdCrossingAlertFields datatype consists of the following
fields:

+-----------------------------------+---------------+-------------+-----------------------------------------------------------------------------------------------------------------------------+
| Field                             | Type          | Required?   | Description                                                                                                                 |
+===================================+===============+=============+=============================================================================================================================+
| thresholdCrossing FieldsVersion   | number        | Yes         | Version of the thresholdCrossingAlertFields block (currently: 2.0)                                                          |
+-----------------------------------+---------------+-------------+-----------------------------------------------------------------------------------------------------------------------------+
| additionalFields                  | field [ ]     | No          | Additional threshold crossing alert fields if needed                                                                        |
+-----------------------------------+---------------+-------------+-----------------------------------------------------------------------------------------------------------------------------+
| additionalParameters              | counter [ ]   | Yes         | Array of performance counters                                                                                               |
+-----------------------------------+---------------+-------------+-----------------------------------------------------------------------------------------------------------------------------+
| alertAction                       | string        | Yes         | Enumeration: 'SET', 'CONT', 'CLEAR'                                                                                         |
+-----------------------------------+---------------+-------------+-----------------------------------------------------------------------------------------------------------------------------+
| alertDescription                  | string        | Yes         | Unique short alert description (e.g., NE-CPUMEM)                                                                            |
+-----------------------------------+---------------+-------------+-----------------------------------------------------------------------------------------------------------------------------+
| alertType                         | string        | Yes         | Enumeration: 'CARD-ANOMALY', 'INTERFACE-ANOMALY', ELEMENT-ANOMALY', 'SERVICE-ANOMALY'                                       |
+-----------------------------------+---------------+-------------+-----------------------------------------------------------------------------------------------------------------------------+
| alertValue                        | string        | No          | Calculated API value (if applicable)                                                                                        |
+-----------------------------------+---------------+-------------+-----------------------------------------------------------------------------------------------------------------------------+
| associatedAlertIdList             | string [ ]    | No          | List of eventIds associated with the event being reported                                                                   |
+-----------------------------------+---------------+-------------+-----------------------------------------------------------------------------------------------------------------------------+
| collectionTimestamp               | string        | Yes         | Time when the performance collector picked up the data; with RFC 2822 compliant format: 'Sat, 13 Mar 2010 11:29:05 -0800'   |
+-----------------------------------+---------------+-------------+-----------------------------------------------------------------------------------------------------------------------------+
| dataCollector                     | string        | No          | Specific performance collector instance used                                                                                |
+-----------------------------------+---------------+-------------+-----------------------------------------------------------------------------------------------------------------------------+
| elementType                       | string        | No          | Type of network element (internal AT&T field)                                                                               |
+-----------------------------------+---------------+-------------+-----------------------------------------------------------------------------------------------------------------------------+
| eventSeverity                     | string        | Yes         | Event severity or priority enumeration: 'CRITICAL', 'MAJOR', 'MINOR', 'WARNING', 'NORMAL'                                   |
+-----------------------------------+---------------+-------------+-----------------------------------------------------------------------------------------------------------------------------+
| eventStartTimestamp               | string        | Yes         | Time closest to when the measurement was made; with RFC 2822 compliant format: 'Sat, 13 Mar 2010 11:29:05 -0800'            |
+-----------------------------------+---------------+-------------+-----------------------------------------------------------------------------------------------------------------------------+
| interfaceName                     | string        | No          | Physical or logical port or card (if applicable)                                                                            |
+-----------------------------------+---------------+-------------+-----------------------------------------------------------------------------------------------------------------------------+
| networkService                    | string        | No          | Network name (internal AT&T field)                                                                                          |
+-----------------------------------+---------------+-------------+-----------------------------------------------------------------------------------------------------------------------------+
| possibleRootCause                 | string        | No          | Reserved for future use                                                                                                     |
+-----------------------------------+---------------+-------------+-----------------------------------------------------------------------------------------------------------------------------+

Technology Specific Datatypes
-----------------------------

'Mobile Flow' Domain Datatypes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Datatype: gtpPerFlowMetrics
^^^^^^^^^^^^^^^^^^^^^^^^^^^

The gtpPerFlowMetrics datatype consists of the following fields:

+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Field                              | Type                | Required?   | Description                                                                                                                                                                                                       |
+====================================+=====================+=============+===================================================================================================================================================================================================================+
| avgBitErrorRate                    | number              | Yes         | Average bit error rate                                                                                                                                                                                            |
+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| avgPacketDelayVariation            | number              | Yes         | Average packet delay variation or jitter in milliseconds for received packets: Average difference between the packet timestamp and time received for all pairs of consecutive packets                             |
+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| avgPacketLatency                   | number              | Yes         | Average delivery latency                                                                                                                                                                                          |
+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| avgReceiveThroughput               | number              | Yes         | Average receive throughput                                                                                                                                                                                        |
+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| avgTransmitThroughput              | number              | Yes         | Average transmit throughput                                                                                                                                                                                       |
+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| durConnectionFailedStatus          | number              | No          | Duration of failed state in milliseconds, computed as the cumulative time between a failed echo request and the next following successful error request, over this reporting interval                             |
+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| durTunnelFailedStatus              | number              | No          | Duration of errored state, computed as the cumulative time between a tunnel error indicator and the next following non-errored indicator, over this reporting interval                                            |
+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| flowActivatedBy                    | string              | No          | Endpoint activating the flow                                                                                                                                                                                      |
+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| flowActivationEpoch                | number              | Yes         | Time the connection is activated in the flow (connection) being reported on, or transmission time of the first packet if activation time is not available                                                         |
+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| flowActivationMicrosec             | number              | Yes         | Integer microseconds for the start of the flow connection                                                                                                                                                         |
+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| flowActivationTime                 | string              | No          | Time the connection is activated in the flow being reported on, or transmission time of the first packet if activation time is not available; with RFC 2822 compliant format: 'Sat, 13 Mar 2010 11:29:05 -0800'   |
+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| flowDeactivatedBy                  | string              | No          | Endpoint deactivating the flow                                                                                                                                                                                    |
+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| flowDeactivationEpoch              | number              | Yes         | Time for the start of the flow connection, in integer UTC epoch time aka UNIX time                                                                                                                                |
+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| flowDeactivationMicrosec           | number              | Yes         | Integer microseconds for the start of the flow connection                                                                                                                                                         |
+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| flowDeactivationTime               | string              | Yes         | Transmission time of the first packet in the flow connection being reported on; with RFC 2822 compliant format: 'Sat, 13 Mar 2010 11:29:05 -0800'                                                                 |
+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| flowStatus                         | string              | Yes         | Connection status at reporting time as a working / inactive / failed indicator value                                                                                                                              |
+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| gtpConnectionStatus                | string              | No          | Current connection state at reporting time                                                                                                                                                                        |
+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| gtpTunnelStatus                    | string              | No          | Current tunnel state at reporting time                                                                                                                                                                            |
+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ipTosCountList                     | associative array   | No          | Array of key: value pairs where the keys are drawn from the IP Type-of-Service identifiers which range from '0' to '255', and the values are the count of packets that had those ToS identifiers in the flow      |
+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ipTosList                          | string              | No          | Array of unique IP Type-of-Service values observed in the flow where values range from '0' to '255'                                                                                                               |
+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| largePacketRtt                     | number              | No          | large packet round trip time                                                                                                                                                                                      |
+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| largePacketThreshold               | number              | No          | large packet threshold being applied                                                                                                                                                                              |
+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| maxPacketDelayVariation            | number              | Yes         | Maximum packet delay variation or jitter in milliseconds for received packets: Maximum of the difference between the packet timestamp and time received for all pairs of consecutive packets                      |
+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| maxReceiveBitRate                  | number              | No          | maximum receive bit rate"                                                                                                                                                                                         |
+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| maxTransmitBitRate                 | number              | No          | maximum transmit bit rate                                                                                                                                                                                         |
+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| mobileQciCosCountList              | associative array   | No          | array of key: value pairs where the keys are drawn from LTE QCI or UMTS class of service strings, and the values are the count of packets that had those strings in the flow                                      |
+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| mobileQciCosList                   | string              | No          | Array of unique LTE QCI or UMTS class-of-service values observed in the flow                                                                                                                                      |
+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| numActivationFailures              | number              | Yes         | Number of failed activation requests, as observed by the reporting node                                                                                                                                           |
+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| numBitErrors                       | number              | Yes         | number of errored bits                                                                                                                                                                                            |
+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| numBytesReceived                   | number              | Yes         | number of bytes received, including retransmissions                                                                                                                                                               |
+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| numBytesTransmitted                | number              | Yes         | number of bytes transmitted, including retransmissions                                                                                                                                                            |
+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| numDroppedPackets                  | number              | Yes         | number of received packets dropped due to errors per virtual interface                                                                                                                                            |
+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| numGtpEchoFailures                 | number              | No          | Number of Echo request path failures where failed paths are defined in 3GPP TS 29.281 sec 7.2.1 and 3GPP TS 29.060 sec. 11.2                                                                                      |
+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| numGtpTunnelErrors                 | number              | No          | Number of tunnel error indications where errors are defined in 3GPP TS 29.281 sec 7.3.1 and 3GPP TS 29.060 sec. 11.1                                                                                              |
+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| numHttpErrors                      | number              | No          | Http error count                                                                                                                                                                                                  |
+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| numL7BytesReceived                 | number              | Yes         | number of tunneled layer 7 bytes received, including retransmissions                                                                                                                                              |
+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| numL7BytesTransmitted              | number              | Yes         | number of tunneled layer 7 bytes transmitted, excluding retransmissions                                                                                                                                           |
+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| numLostPackets                     | number              | Yes         | number of lost packets                                                                                                                                                                                            |
+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| numOutOfOrderPackets               | number              | Yes         | number of out-of-order packets                                                                                                                                                                                    |
+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| numPacketErrors                    | number              | Yes         | number of errored packets                                                                                                                                                                                         |
+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| numPacketsReceivedExclRetrans      | number              | Yes         | number of packets received, excluding retransmission                                                                                                                                                              |
+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| numPacketsReceivedInclRetrans      | number              | Yes         | number of packets received, including retransmission                                                                                                                                                              |
+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| numPacketsTransmittedInclRetrans   | number              | Yes         | number of packets transmitted, including retransmissions                                                                                                                                                          |
+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| numRetries                         | number              | Yes         | number of packet retries                                                                                                                                                                                           |
+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| numTimeouts                        | number              | Yes         | number of packet timeouts                                                                                                                                                                                         |
+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| numTunneledL7BytesReceived         | number              | Yes         | number of tunneled layer 7 bytes received, excluding retransmissions                                                                                                                                              |
+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| roundTripTime                      | number              | Yes         | Round Trip time                                                                                                                                                                                                   |
+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| tcpFlagCountList                   | associative array   | No          | Array of key: value pairs where the keys are drawn from TCP Flags and the values are the count of packets that had that TCP Flag in the flow                                                                      |
+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| tcpFlagList                        | string              | No          | Array of unique TCP Flags observed in the flow                                                                                                                                                                    |
+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| timeToFirstByte                    | number              | Yes         | Time in milliseconds between the connection activation and first byte received                                                                                                                                    |
+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Datatype: mobileFlowFields
^^^^^^^^^^^^^^^^^^^^^^^^^^

The mobileFlowFields datatype consists of the following fields:

+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Field                     | Type                 | Required?   | Description                                                                                                                                                                                  |
+===========================+======================+=============+==============================================================================================================================================================================================+
| mobileFlowFieldsVersion   | number               | Yes         | Version of the mobileFlowFields block (currently: 2.0)                                                                                                                                       |
+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| additionalFields          | field [ ]            | No          | Additional mobileFlow fields if needed                                                                                                                                                       |
+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| applicationType           | string               | No          | Application type inferred                                                                                                                                                                    |
+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| appProtocolType           | string               | No          | Application protocol                                                                                                                                                                         |
+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| appProtocolVersion        | string               | No          | Application version                                                                                                                                                                          |
+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| cid                       | string               | No          | Cell Id                                                                                                                                                                                      |
+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| connectionType            | string               | No          | Abbreviation referencing a 3GPP reference point e.g., S1-U, S11, etc                                                                                                                         |
+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ecgi                      | string               | No          | Evolved Cell Global Id                                                                                                                                                                       |
+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| flowDirection             | string               | Yes         | Flow direction, indicating if the reporting node is the source of the flow or destination for the flow                                                                                       |
+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| gtpPerFlowMetrics         | gtpPer FlowMetrics   | Yes         | Mobility GTP Protocol per flow metrics                                                                                                                                                       |
+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| gtpProtocolType           | string               | No          | GTP protocol                                                                                                                                                                                 |
+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| gtpVersion                | string               | No          | GTP protocol version                                                                                                                                                                         |
+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| httpHeader                | string               | No          | HTTP request header, if the flow connects to a node referenced by HTTP                                                                                                                       |
+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| imei                      | string               | No          | IMEI for the subscriber UE used in this flow, if the flow connects to a mobile device                                                                                                        |
+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| imsi                      | string               | No          | IMSI for the subscriber UE used in this flow, if the flow connects to a mobile device                                                                                                        |
+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ipProtocolType            | string               | Yes         | IP protocol type e.g., TCP, UDP, RTP...                                                                                                                                                      |
+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ipVersion                 | string               | Yes         | IP protocol version e.g., IPv4, IPv6                                                                                                                                                         |
+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| lac                       | string               | No          | Location area code                                                                                                                                                                           |
+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| mcc                       | string               | No          | Mobile country code                                                                                                                                                                          |
+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| mnc                       | string               | No          | Mobile network code                                                                                                                                                                          |
+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| msisdn                    | string               | No          | MSISDN for the subscriber UE used in this flow, as an integer, if the flow connects to a mobile device                                                                                       |
+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| otherEndpointIpAddress    | string               | Yes         | IP address for the other endpoint, as used for the flow being reported on                                                                                                                    |
+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| otherEndpointPort         | integer              | Yes         | IP Port for the reporting entity, as used for the flow being reported on                                                                                                                     |
+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| otherFunctionalRole       | string               | No          | Functional role of the other endpoint for the flow being reported on e.g., MME, S-GW, P-GW, PCRF...                                                                                          |
+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| rac                       | string               | No          | Routing area code                                                                                                                                                                            |
+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| radioAccessTechnology     | string               | No          | Radio Access Technology e.g., 2G, 3G, LTE                                                                                                                                                    |
+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| reportingEndpointIpAddr   | string               | Yes         | IP address for the reporting entity, as used for the flow being reported on                                                                                                                  |
+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| reportingEndpointPort     | integer              | Yes         | IP port for the reporting entity, as used for the flow being reported on                                                                                                                     |
+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| sac                       | string               | No          | Service area code                                                                                                                                                                            |
+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| samplingAlgorithm         | integer              | No          | Integer identifier for the sampling algorithm or rule being applied in calculating the flow metrics if metrics are calculated based on a sample of packets, or 0 if no sampling is applied   |
+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| tac                       | string               | No          | Transport area code                                                                                                                                                                          |
+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| tunnelId                  | string               | No          | Tunnel identifier                                                                                                                                                                            |
+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| vlanId                    | string               | No          | VLAN identifier used by this flow                                                                                                                                                            |
+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

'SipSignaling'Domain Datatypes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Datatype: sipSignalingFields
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The sipSignalingFields datatype communicates information about sip
signaling messages, parameters and signaling state; it consists of the
following fields:

+-----------------------------+-----------------------+-------------+---------------------------------------------------------------+
| Field                       | Type                  | Required?   | Description                                                   |
+=============================+=======================+=============+===============================================================+
| sipSignalingFieldsVersion   | number                | Yes         | Version of the sipSignalingFields block (currently: 1.0)      |
+-----------------------------+-----------------------+-------------+---------------------------------------------------------------+
| additionalInformation       | field [ ]             | No          | Additional sipSignaling fields                                |
+-----------------------------+-----------------------+-------------+---------------------------------------------------------------+
| compressedSip               | string                | No          | The full SIP request/response including headers and bodies    |
+-----------------------------+-----------------------+-------------+---------------------------------------------------------------+
| correlator                  | string                | Yes         | Constant across all events on this call                       |
+-----------------------------+-----------------------+-------------+---------------------------------------------------------------+
| localIpAddress              | string                | Yes         | IP address on VNF                                             |
+-----------------------------+-----------------------+-------------+---------------------------------------------------------------+
| localPort                   | string                | Yes         | Port on VNF                                                   |
+-----------------------------+-----------------------+-------------+---------------------------------------------------------------+
| remoteIpAddress             | string                | Yes         | IP address of peer endpoint                                   |
+-----------------------------+-----------------------+-------------+---------------------------------------------------------------+
| remotePort                  | string                | Yes         | Port of peer endpoint                                         |
+-----------------------------+-----------------------+-------------+---------------------------------------------------------------+
| summarySip                  | string                | No          | The SIP Method or Response ('INVITE', '200 OK', 'BYE', etc)   |
+-----------------------------+-----------------------+-------------+---------------------------------------------------------------+
| vendorVnfNameFields         | vendorVnfNameFields   | Yes         | Vendor, VNF and VfModule names                                |
+-----------------------------+-----------------------+-------------+---------------------------------------------------------------+

'Voice Quality'Domain Datatypes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Datatype: endOfCallVqmSummaries
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The endOfCallVqmSummaries datatype provides end of call voice quality
metrics; it consists of the following fields:

+-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Field                         | Type     | Required?   | Description                                                                                                                                                                                                      |
+===============================+==========+=============+==================================================================================================================================================================================================================+
| adjacencyName                 | string   | Yes         | Adjacency name                                                                                                                                                                                                   |
+-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| endpointDescription           | string   | Yes         | Enumeration: 'Caller', 'Callee'                                                                                                                                                                                  |
+-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| endpointJitter                | number   | No          | Endpoint jitter                                                                                                                                                                                                  |
+-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| endpointRtpOctetsDiscarded    | number   | No          | Endpoint RTP octets discarded                                                                                                                                                                                    |
+-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| endpointRtpOctetsReceived     | number   | No          | Endpoint RTP octets received                                                                                                                                                                                     |
+-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| endpointRtpOctetsSent         | number   | No          | Endpoint RTP octets sent                                                                                                                                                                                         |
+-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| endpointRtpPacketsDiscarded   | number   | No          | Endpoint RTP packets discarded                                                                                                                                                                                   |
+-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| endpointRtpPacketsReceived    | number   | No          | Endpoint RTP packets received                                                                                                                                                                                    |
+-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| endpointRtpPacketsSent        | number   | No          | Endpoint RTP packets sent                                                                                                                                                                                        |
+-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| localJitter                   | number   | No          | Local jitter                                                                                                                                                                                                     |
+-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| localRtpOctetsDiscarded       | number   | No          | Local RTP octets discarded                                                                                                                                                                                       |
+-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| localRtpOctetsReceived        | number   | No          | Local RTP octets received                                                                                                                                                                                        |
+-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| localRtpOctetsSent            | number   | No          | Local RTP octets sent                                                                                                                                                                                            |
+-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| localRtpPacketsDiscarded      | number   | No          | Local RTP packets discarded                                                                                                                                                                                      |
+-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| localRtpPacketsReceived       | number   | No          | Local RTP packets received                                                                                                                                                                                       |
+-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| localRtpPacketsSent           | number   | No          | Local RTP packets sent                                                                                                                                                                                           |
+-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| mosCqe                        | number   | No          | Decimal range from 1 to 5 (1 decimal place)                                                                                                                                                                      |
+-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| packetsLost                   | number   | No          | Packets lost                                                                                                                                                                                                     |
+-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| packetLossPercent             | number   | No          | Calculated percentage packet loss based on endpoint RTP packets lost (as reported in RTCP) and local RTP packets sent. Direction is based on endpoint description (Caller, Callee). Decimal (2 decimal places)   |
+-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| rFactor                       | number   | No          | rFactor from 0 to 100                                                                                                                                                                                            |
+-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| roundTripDelay                | number   | No          | Round trip delay in milliseconds                                                                                                                                                                                 |
+-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Datatype: voiceQualityFields
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The voiceQualityFields datatype provides statistics related to customer
facing voice products; consists of the following fields:

+-----------------------------+--------------------------+-------------+--------------------------------------------------------------------------+
| Field                       | Type                     | Required?   | Description                                                              |
+=============================+==========================+=============+==========================================================================+
| voiceQualityFieldsVersion   | number                   | Yes         | Version of the voiceQualityFields block (currently: 1.0)                 |
+-----------------------------+--------------------------+-------------+--------------------------------------------------------------------------+
| additionalInformation       | field [ ]                | No          | Additional voice quality fields                                          |
+-----------------------------+--------------------------+-------------+--------------------------------------------------------------------------+
| calleeSideCodec             | string                   | Yes         | Callee codec for the call                                                |
+-----------------------------+--------------------------+-------------+--------------------------------------------------------------------------+
| callerSideCodec             | string                   | Yes         | Caller codec for the call                                                |
+-----------------------------+--------------------------+-------------+--------------------------------------------------------------------------+
| correlator                  | string                   | Yes         | Constant across all events on this call                                  |
+-----------------------------+--------------------------+-------------+--------------------------------------------------------------------------+
| endOfCallVqmSummaries       | endOfCallVqm Summaries   | No          | End of call voice quality metric summaries                               |
+-----------------------------+--------------------------+-------------+--------------------------------------------------------------------------+
| phoneNumber                 | string                   | No          | Phone number associated with the correlator                              |
+-----------------------------+--------------------------+-------------+--------------------------------------------------------------------------+
| midCallRtcp                 | string                   | Yes         | Base64 encoding of the binary RTCP data (excluding Eth/IP/UDP headers)   |
+-----------------------------+--------------------------+-------------+--------------------------------------------------------------------------+
| vendorVnfNameFields         | vendorVnfNameFields      | Yes         | Vendor, VNF and VfModule names                                           |
+-----------------------------+--------------------------+-------------+--------------------------------------------------------------------------+

Exceptions
==========

RESTful Web Services Exceptions
-------------------------------

RESTful services generate and send exceptions to clients in response to
invocation errors. Exceptions send HTTP status codes (specified later in
this document for each operation). HTTP status codes may be followed by
an optional JSON exception structure described below. Two types of
exceptions may be defined: service exceptions and policy exceptions.

+------------------+----------------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Field Name**   | **Data Type**              | **Required?**   | **Description**                                                                                                                                                                                                                                                        |
+==================+============================+=================+========================================================================================================================================================================================================================================================================+
| messageId        | xs:string                  | Yes             | Unique message identifier of the format 'ABCnnnn'where 'ABC'is either 'SVC'for Service Exceptions or 'POL'for Policy Exception.                                                                                                                                        |
|                  |                            |                 |                                                                                                                                                                                                                                                                        |
|                  |                            |                 | Exception numbers may be in the range of 0001 to 9999 where :                                                                                                                                                                                                          |
|                  |                            |                 |                                                                                                                                                                                                                                                                        |
|                  |                            |                 | -  0001 to 2999 are defined by OMA (see OMA's `Common definitions for RESTful Network APIs <http://technical.openmobilealliance.org/Technical/release_program/docs/REST_NetAPI_Common/V1_0-20120417-C/OMA-TS-REST_NetAPI_Common-V1_0-20120417-C.pdf>`__ for details)   |
|                  |                            |                 |                                                                                                                                                                                                                                                                        |
|                  |                            |                 | -  3000-9999 are available and undefined                                                                                                                                                                                                                               |
+------------------+----------------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| text             | xs:string                  | Yes             | Message text, with replacement variables marked with %n, where n is an index into the list of <variables> elements, starting at 1                                                                                                                                      |
+------------------+----------------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| variables        | xs:string [0..unbounded]   | No              | List of zero or more strings that represent the contents of the variables used by the message text.                                                                                                                                                                    |
+------------------+----------------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| url              | xs:anyUrl                  | No              | Hyperlink to a detailed error resource (e.g., an HTML page for browser user agents).                                                                                                                                                                                   |
+------------------+----------------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Service Exceptions
------------------

When a service is not able to process a request, and retrying the
request with the same information will also result in a failure, and the
issue is not related to a service policy issue, then the service will
issue a fault using the service exception fault message. Examples of
service exceptions include invalid input, lack of availability of a
required resource or a processing error.

A service exception uses the letters 'SVC' at the beginning of the
message identifier. 'SVC'service exceptions used by the VES Event
Listener API are defined below.

+---------------+---------------------------------------+---------------------------------------------------------------+-----------------------------------------------+----------------------+
| *MessageId*   | *Description / Comment*               | *Text*                                                        | *Variables*                                   | *Parent HTTP Code*   |
+===============+=======================================+===============================================================+===============================================+======================+
| SVC0001       | General service error (see SVC2000)   | <custom error message>                                        | None                                          | 400                  |
+---------------+---------------------------------------+---------------------------------------------------------------+-----------------------------------------------+----------------------+
| SVC0002       | Bad parameter                         | Invalid input value for message part %1                       | %1: message part                              | 400                  |
+---------------+---------------------------------------+---------------------------------------------------------------+-----------------------------------------------+----------------------+
| SVC1000       | No server resources                   | No server resources available to process the request          | None                                          | 500                  |
+---------------+---------------------------------------+---------------------------------------------------------------+-----------------------------------------------+----------------------+
| SVC2000       | More elaborate version of SVC0001     | The following service error occurred: %1. Error code is %2.   | %1: human readable description of the error   | 400                  |
|               |                                       |                                                               |                                               |                      |
|               |                                       |                                                               | %2: error code                                |                      |
+---------------+---------------------------------------+---------------------------------------------------------------+-----------------------------------------------+----------------------+

    Table - Service Exceptions

Policy Exceptions
-----------------

When a service is not able to complete because the request fails to meet
a policy criteria, then the service will issue a fault using the policy
exception fault message. To clarify how a policy exception differs from
a service exception, consider that all the input to an operation may be
valid as meeting the required input for the operation (thus no service
exception), but using that input in the execution of the service may
result in conditions that require the service not to complete. Examples
of policy exceptions include privacy violations, requests not permitted
under a governing service agreement or input content not acceptable to
the service provider.

A Policy Exception uses the letters 'POL' at the beginning of the
message identifier. 'POL'policy exceptions used by the VES Event
Listener API are defined below.

+---------------+--------------------------------------+--------------------------------------------------------------+-----------------------------------------------+----------------------+
| *MessageId*   | *Description / Comment*              | *Text*                                                       | *Variables*                                   | *Parent HTTP Code*   |
+===============+======================================+==============================================================+===============================================+======================+
| POL0001       | General policy error (see POL2000)   | A policy error occurred.                                     | None                                          | 401                  |
+---------------+--------------------------------------+--------------------------------------------------------------+-----------------------------------------------+----------------------+
| POL1009       | User not provisioned for service     | User has not been provisioned for service                    | None                                          | 401                  |
+---------------+--------------------------------------+--------------------------------------------------------------+-----------------------------------------------+----------------------+
| POL1010       | User suspended from service          | User has been suspended from service                         | None                                          | 401                  |
+---------------+--------------------------------------+--------------------------------------------------------------+-----------------------------------------------+----------------------+
| POL2000       | More elaborate version of POL0001    | The following policy error occurred: %1. Error code is %2.   | %1: human readable description of the error   | 401                  |
|               |                                      |                                                              |                                               |                      |
|               |                                      |                                                              | %2: error code                                |                      |
+---------------+--------------------------------------+--------------------------------------------------------------+-----------------------------------------------+----------------------+
| POL9003       | Message size exceeds limit           | Message content size exceeds the allowable limit             | None                                          | 400                  |
+---------------+--------------------------------------+--------------------------------------------------------------+-----------------------------------------------+----------------------+

    Table - Policy Exceptions

RESTful Web Services Definition
===============================

REST Operation Overview
-----------------------

REST Operation Summary
~~~~~~~~~~~~~~~~~~~~~~~

+--------------------------------+------------+----------------------------------------------------------------------------+
| **Operation Action**           | **HTTP**   | **Resource URL relative to {ServerRoot}, which is defined in section 3**   |
|                                |            |                                                                            |
|                                | **Verb**   |                                                                            |
+--------------------------------+------------+----------------------------------------------------------------------------+
| publishAnyEvent                | POST       | /eventListener/v{apiVersion}                                               |
+--------------------------------+------------+----------------------------------------------------------------------------+
| publishEventBatch              | POST       | /eventListener/v{apiVersion}/eventBatch                                    |
+--------------------------------+------------+----------------------------------------------------------------------------+
| provideClientThrottlingState   | POST       | /eventListener/v{apiVersion}/clientThrottlingState                         |
+--------------------------------+------------+----------------------------------------------------------------------------+

Table - REST Operation Summary

API Version
~~~~~~~~~~~

apiVersion is used to describe the major version number of the event
listener API (which is the same as the major version number of this
specification). When this number changes, the implication is: clients of
older versions will break in some way, if they try to use the new API
without modification (e.g., unmodified v1 clients would not be able to
use v2 without error).

Commands Toward Event Source Clients
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Note: Vendors are not currently required to implement support for
command processing; in addition, command processing may be supported by
an App-C interface in future.

This specification supports commands from event consumers back toward
event source clients. This enables the event consumer (e.g., AT&T event
collectors) to command event sources to change their measurement
intervals or throttle the information they are sending to the event
consumer. Note that commands are sent as part of the synchronous
response to events sent by the event source toward the event consumer.
This is done so that the event source does not need to host a service to
listen for commands from events consumers. The following commands are
currently supported:

+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Command**                 | **Description**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| heartbeatInterval Change    | Commands the event source to change the interval (in seconds) it waits between heartbeat events sent to the VES Event Listener. If '0'is provided, the event source should return to its default heartbeatInterval.                                                                                                                                                                                                                                                                                                                               |
+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| measurementIntervalChange   | Commands the event source to change its measurementInterval to the number provided (in seconds). If '0'is provided, the event source should return to its default measurementInterval.                                                                                                                                                                                                                                                                                                                                                            |
+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| provideThrottlingState      | Commands the event source to invoke the provideThrottlingState operation on the event consumer.                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| throttlingSpecification     | Commands the event source to throttle events as specified by the provided eventDomainThrottlingSpecification. This specification identifies the fields to suppress within the domain and even supports identification of subfields to suppress within objects or name-value pair structures. Note that required fields should not be suppressed and may result in errors being thrown by the event consumer back toward the event source when events without the required fields are sent to the event consumer. Other notes for event sources:   |
|                             |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|                             | -  the default throttling state is \*off\* for all domains                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|                             |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|                             | -  the throttling state for a domain is altered only by receipt of an eventDomainThrottleSpecification for that domain                                                                                                                                                                                                                                                                                                                                                                                                                            |
|                             |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|                             | -  the presence of the optional suppressedFieldNames replaces any existing list of suppressed field names                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|                             |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|                             | -  if suppressedFieldNames is not provided, then any existing list of suppressed field names shall be discarded                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|                             |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|                             | -  the presence of the optional suppressedNvPairsList replaces the any existing list of suppressed name-value pairs                                                                                                                                                                                                                                                                                                                                                                                                                               |
|                             |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|                             | -  if suppressedNvPairsList is not provided, then any existing list of suppressed name-value pairs shall be discarded                                                                                                                                                                                                                                                                                                                                                                                                                             |
+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Buffering of Events
~~~~~~~~~~~~~~~~~~~~

{ServerRoot} is defined in section 3 of this document, which defines the
REST resource URL. One or more FQDNs may be provisioned in an event
source when it is instantiated or updated. If an event source is unable
to reach any of the provisioned FQDNs, it should buffer the event data
specified below, up to a maximum of 1 hour, until a connection can be
established and the events can be successfully delivered to the VES
Event Listener service.

During such an outage, only the following events should be buffered:

-  Faults with eventSeverity of "MINOR", "MAJOR" or "CRITICAL"

-  Syslogs with syslogSev of 0-5

-  All MeasurementsForVfScaling events

VNFs acting as event sources should not send syslog events to the VES
Event Listener during debug mode (which is controlled via the Netconf
management interface), but should store syslog events locally for
access, and possible FTP transfer, via the VNF console (e.g., command
line interface).

If the internal event source event buffer or local storage should
overflow, then the event source should send a Fault event, and should
discard events in a first-in, first-out (FIFO) manner (i.e., discard
oldest events first).

Operation: publishAnyEvent
--------------------------

Functional Behavior
~~~~~~~~~~~~~~~~~~~

Allows authorized clients to publish any single event to the VES event
listener.

-  Supports only secure HTTPS (one way SSL) access.

-  Uses the HTTP verb POST

-  Supports JSON content types

-  Provides HTTP response codes as well as Service and Policy error
   messages

-  Allows the event collector to use the HTTP response to command the
   event source to throttle event messages it may send in the future.

Call Flow
~~~~~~~~~

|image1|

Figure 2 - publishAnyEvent Call Flow

Input Parameters
~~~~~~~~~~~~~~~~

Header Fields (note: all parameter names shall be treated as
case-insensitive):

+------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Parameter**    | **Data Type**   | **Required?**   | **Brief description**                                                                                                                                                                                                                                                                                                                                                                                                                                 |
+------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Accept           | string          | No              | Determines the format of the body of the response. Valid values are:                                                                                                                                                                                                                                                                                                                                                                                  |
|                  |                 |                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|                  |                 |                 | -  application/json                                                                                                                                                                                                                                                                                                                                                                                                                                   |
+------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Authorization    | string          | Yes             | The username and password are formed into one string as "username:password". This string is then Base64 encoded to produce the encoded credential which is communicated in the header after the string "Authorization: Basic ". See examples below. If the Authorization header is missing, then an HTTP 400 Invalid Request message shall be returned. If the string supplied is invalid, then an HTTP 401 Unauthorized message shall be returned.   |
+------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Content-length   | integer         | No              | Note that content length is limited to 1Megabyte.                                                                                                                                                                                                                                                                                                                                                                                                     |
+------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Content-type     | string          | Yes             | Must be set to one of the following values:                                                                                                                                                                                                                                                                                                                                                                                                           |
|                  |                 |                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|                  |                 |                 | -  application/json                                                                                                                                                                                                                                                                                                                                                                                                                                   |
+------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Body Fields:

+-----------------+-----------------+-----------------+-----------------------------------------------------------+
| **Parameter**   | **Data Type**   | **Required?**   | **Brief description**                                     |
+-----------------+-----------------+-----------------+-----------------------------------------------------------+
| Event           | event           | Yes             | Contains the JSON structure of the common event format.   |
+-----------------+-----------------+-----------------+-----------------------------------------------------------+

Output Parameters
~~~~~~~~~~~~~~~~~

Header fields:

+------------------+-----------------+-----------------+------------------------------------+
| **Parameter**    | **Data Type**   | **Required?**   | **Brief description**              |
+------------------+-----------------+-----------------+------------------------------------+
| Content-length   | integer         | No              | Used only in error conditions.     |
+------------------+-----------------+-----------------+------------------------------------+
| Content-type     | string          | No              | Used only in error conditions      |
+------------------+-----------------+-----------------+------------------------------------+
| Date             | datetime        | Yes             | Date time of the response in GMT   |
+------------------+-----------------+-----------------+------------------------------------+

Body Fields (for success responses without a commandList): no content is
provided and the header fields are not required.

Body Fields (for success responses with one or more commands from the
event collector toward the event source):

+-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Parameter**   | **Data Type**   | **Required?**   | **Brief description**                                                                                                                                                                                                                                                                                                                                                                                     |
+-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| commandList     | commandList     | No              | Array of commands (e.g., measurement Interval changes and/or what fields to suppress within specified event domains and/or a request to report the state of event throttling by event domain that is currently in force in the event source). Note: for 'provideThrottlingState'commands, the client should subsequently provide the throttling state by calling the provideThrottlingState operation.    |
+-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Body Fields (for error Responses):

+-----------------+-----------------+--------------------+----------------------------------+
| **Parameter**   | **Data Type**   | **Required?**      | **Brief description**            |
+-----------------+-----------------+--------------------+----------------------------------+
| requestError    | requestError    | Yes (for errors)   | Used only in error conditions.   |
+-----------------+-----------------+--------------------+----------------------------------+

HTTP Status Codes
~~~~~~~~~~~~~~~~~

+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| *Code*   | *Reason Phrase*         | *Description*                                                                                                                                                                                                                                                                                                                                                                            |
+==========+=========================+==========================================================================================================================================================================================================================================================================================================================================================================================+
| 202      | Accepted                | The request has been accepted for processing                                                                                                                                                                                                                                                                                                                                             |
+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 400      | Bad Request             | Many possible reasons not specified by the other codes (e.g., missing required parameters or incorrect format). The response body may include a further exception code and text. HTTP 400 errors may be mapped to SVC0001 (general service error), SVC0002 (bad parameter), SVC2000 (general service error with details) or PO9003 (message content size exceeds the allowable limit).   |
+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 401      | Unauthorized            | Authentication failed or was not provided. HTTP 401 errors may be mapped to POL0001 (general policy error) or POL2000 (general policy error with details).                                                                                                                                                                                                                               |
+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 404      | Not Found               | The server has not found anything matching the Request-URI. No indication is given of whether the condition is temporary or permanent.                                                                                                                                                                                                                                                   |
+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 405      | Method Not Allowed      | A request was made of a resource using a request method not supported by that resource (e.g., using PUT on a REST resource that only supports POST).                                                                                                                                                                                                                                     |
+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 500      | Internal Server Error   | The server encountered an internal error or timed out; please retry (general catch-all server-side error).HTTP 500 errors may be mapped to SVC1000 (no server resources).                                                                                                                                                                                                                |
+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Sample Request and Response
~~~~~~~~~~~~~~~~~~~~~~~~~~~

Sample Request
^^^^^^^^^^^^^^

 .. code:: bash
 
 POST /eventListener/v5 HTTPS/1.1
 Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
 content-type: application/json
 content-length: 12345
	{
		"event": {
			"commonEventHeader": {
				"version": 3.0,
				"domain": "fault",
				"eventName": Fault\_MobileCallRecording\_PilotNumberPoolExhaustion",
				"eventId": "ab305d54-85b4-a31b-7db2-fb6b9e546015",
				"sequence": 0,
				"priority": "High",
				"reportingEntityId": "cc305d54-75b4-431b-adb2-eb6b9e541234",
				"reportingEntityName": "EricssonOamVf",
				"sourceId": "de305d54-75b4-431b-adb2-eb6b9e546014",
				"sourceName": "scfx0001vm002cap001",
				"nfNamingCode": "scfx",
				"nfcNamingCode": "ssc",
				"startEpochMicrosec": 1413378172000000,
				"lastEpochMicrosec": 1413378172000000
			},
			"faultFields": {
				"faultFieldsVersion": 2.0,
				"alarmCondition": "PilotNumberPoolExhaustion",
				"eventSourceType": "other",
				"specificProblem": "Calls cannot complete - pilot numbers are unavailable",
				"eventSeverity": "CRITICAL",
				"vfStatus": "Active",
				"alarmAdditionalInformation": [
					{
					"name": "PilotNumberPoolSize",
					"value": "1000"
					}
				]
			}
		}
	}

Sample Success Response #1
^^^^^^^^^^^^^^^^^^^^^^^^^^

    For success responses without a provided command list:

    .. code:: bash

    HTTPS/1.1 202 Accepted

Sample Success Response #2
^^^^^^^^^^^^^^^^^^^^^^^^^^

    For success responses with a provided command list:

    .. code:: bash

    HTTPS/1.1 202 Accepted
    content-type: application/json
    content-length: nnn
    date: Sat, 04 Jul 2015 02:03:15 GMT
    {
    "commandList": [
        {
            "commandType": "throttlingSpecification",
            "eventDomainThrottleSpecification": {
                "eventDomain": "fault",
                "suppressedFieldNames": [
                    "alarmInterfaceA",
                    "alarmAdditionalInformation"
		]
	    }
	},
        {
            "commandType": "throttlingSpecification",
            eventDomainThrottleSpecification": {
		"eventDomain": "thresholdCrossingAlert",
		"suppressedFieldNames": [
        		"associatedAlertIdList",
			"possibleRootCause"
		],
		"suppressedNvPairs" {
			"nvPairFieldName": additionalParameters",
			"suppressedNvPairNames": [
				"someCounterName",
				"someOtherCounterName"
			]
		}
             }
	},
			{
				"commandType": "measurementIntervalChange",
				"measurementInterval": 600
			},
			{
				"commandType": "heartbeatIntervalChange",
				"heartbeatInterval": 90
			},
			{
				"commandType": "provideThrottlingState"
			}
		]
		}

1. .. rubric:: Sample Error Responses

      :name: sample-error-responses

   1. .. rubric:: Sample Policy Exception

        :name: sample-policy-exception

	.. code:: bash

		HTTPS/1.1 400 Bad Request
		content-type: application/json
		content-length: 12345
		Date: Thu, 04 Jun 2009 02:51:59 GMT
		{
			"requestError": {
				"policyException": {
					"messageId": "POL9003",
					"text": "Message content size exceeds the allowable limit",
				}
			}
		}

Sample Service Exception
''''''''''''''''''''''''

	.. code:: bash

		HTTPS/1.1 400 Bad Request
		content-type: application/json
		content-length: 12345
		Date: Thu, 04 Jun 2009 02:51:59 GMT
		{
			"requestError": {
				"serviceException": {
					"messageId": "SVC2000",
					"text": "Missing Parameter: %1. Error code is %2"
					"variables": [
						"severity",
						"400"
					]
				}
			}
		}

Operation: publishEventBatch
----------------------------

Functional Behavior
~~~~~~~~~~~~~~~~~~~

Allows authorized clients to publish any single event to the VES event
listener.

-  Supports only secure HTTPS (one way SSL) access.

-  Uses the HTTP verb POST

-  Supports JSON content types

-  Provides HTTP response codes as well as Service and Policy error
   messages

-  Allows the event collector to use the HTTP response to command the
   event source to throttle event messages it may send in the future.

Call Flow
~~~~~~~~~

|image2|

Figure 3 publishEventBatch Call Flow

Input Parameters
~~~~~~~~~~~~~~~~

Header Fields (note: all parameter names shall be treated as
case-insensitive):

+------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Parameter**    | **Data Type**   | **Required?**   | **Brief description**                                                                                                                                                                                                                                                                                                                                                                                                                                 |
+------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Accept           | string          | No              | Determines the format of the body of the response. Valid values are:                                                                                                                                                                                                                                                                                                                                                                                  |
|                  |                 |                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|                  |                 |                 | -  application/json                                                                                                                                                                                                                                                                                                                                                                                                                                   |
+------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Authorization    | string          | Yes             | The username and password are formed into one string as "username:password". This string is then Base64 encoded to produce the encoded credential which is communicated in the header after the string "Authorization: Basic ". See examples below. If the Authorization header is missing, then an HTTP 400 Invalid Request message shall be returned. If the string supplied is invalid, then an HTTP 401 Unauthorized message shall be returned.   |
+------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Content-length   | integer         | No              | Note that content length is limited to 1Megabyte.                                                                                                                                                                                                                                                                                                                                                                                                     |
+------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Content-type     | string          | Yes             | Must be set to one of the following values:                                                                                                                                                                                                                                                                                                                                                                                                           |
|                  |                 |                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|                  |                 |                 | -  application/json                                                                                                                                                                                                                                                                                                                                                                                                                                   |
+------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Body Fields:

+-----------------+-----------------+-----------------+----------------------------------------------------------+
| **Parameter**   | **Data Type**   | **Required?**   | **Brief description**                                    |
+-----------------+-----------------+-----------------+----------------------------------------------------------+
| eventList       | eventList       | Yes             | Array of events conforming to the common event format.   |
+-----------------+-----------------+-----------------+----------------------------------------------------------+

Output Parameters
~~~~~~~~~~~~~~~~~

Header fields:

+------------------+-----------------+-----------------+------------------------------------+
| **Parameter**    | **Data Type**   | **Required?**   | **Brief description**              |
+------------------+-----------------+-----------------+------------------------------------+
| Content-length   | integer         | No              | Used only in error conditions.     |
+------------------+-----------------+-----------------+------------------------------------+
| Content-type     | string          | No              | Used only in error conditions      |
+------------------+-----------------+-----------------+------------------------------------+
| Date             | datetime        | Yes             | Date time of the response in GMT   |
+------------------+-----------------+-----------------+------------------------------------+

Body Fields (for success responses without a commandList): no content is
provided and the header fields are not required.

Body Fields (for success responses with one or more commands from the
event collector toward the event source):

+-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Parameter**   | **Data Type**   | **Required?**   | **Brief description**                                                                                                                                                                                                                                                                                                                                                                                     |
+-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| commandList     | commandList     | No              | Array of commands (e.g., measurement Interval changes and/or what fields to suppress within specified event domains and/or a request to report the state of event throttling by event domain that is currently in force in the event source). Note: for 'provideThrottlingState'commands, the client should subsequently provide the throttling state by calling the provideThrottlingState operation.    |
+-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Body Fields (for error Responses):

+-----------------+-----------------+--------------------+----------------------------------+
| **Parameter**   | **Data Type**   | **Required?**      | **Brief description**            |
+-----------------+-----------------+--------------------+----------------------------------+
| requestError    | requestError    | Yes (for errors)   | Used only in error conditions.   |
+-----------------+-----------------+--------------------+----------------------------------+

HTTP Status Codes
~~~~~~~~~~~~~~~~~

+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| *Code*   | *Reason Phrase*         | *Description*                                                                                                                                                                                                                                                                                                                                                                            |
+==========+=========================+==========================================================================================================================================================================================================================================================================================================================================================================================+
| 202      | Accepted                | The request has been accepted for processing                                                                                                                                                                                                                                                                                                                                             |
+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 400      | Bad Request             | Many possible reasons not specified by the other codes (e.g., missing required parameters or incorrect format). The response body may include a further exception code and text. HTTP 400 errors may be mapped to SVC0001 (general service error), SVC0002 (bad parameter), SVC2000 (general service error with details) or PO9003 (message content size exceeds the allowable limit).   |
+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 401      | Unauthorized            | Authentication failed or was not provided. HTTP 401 errors may be mapped to POL0001 (general policy error) or POL2000 (general policy error with details).                                                                                                                                                                                                                               |
+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 404      | Not Found               | The server has not found anything matching the Request-URI. No indication is given of whether the condition is temporary or permanent.                                                                                                                                                                                                                                                   |
+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 405      | Method Not Allowed      | A request was made of a resource using a request method not supported by that resource (e.g., using PUT on a REST resource that only supports POST).                                                                                                                                                                                                                                     |
+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 500      | Internal Server Error   | The server encountered an internal error or timed out; please retry (general catch-all server-side error).HTTP 500 errors may be mapped to SVC1000 (no server resources).                                                                                                                                                                                                                |
+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Sample Request and Response
~~~~~~~~~~~~~~~~~~~~~~~~~~~

Sample Request
^^^^^^^^^^^^^^

	.. code:: bash

		POST /eventListener/v5/eventBatch HTTPS/1.1
		Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
		content-type: application/json
		content-length: 12345
		{
			"eventList": [
			{
				"commonEventHeader": {
					"version": 3.0,
					"domain": "fault",
					"eventName": "Fault\_MobileCallRecording\_PilotNumberPoolExhaustion",
					"eventId": "ab305d54-85b4-a31b-7db2-fb6b9e546015",
					"sequence": 0,
					"priority": "High",
					"reportingEntityId": "cc305d54-75b4-431b-adb2-eb6b9e541234",
					"reportingEntityName": "EricssonOamVf",
					"sourceId": "de305d54-75b4-431b-adb2-eb6b9e546014",
					"sourceName": "scfx0001vm002cap001",
					"nfNamingCode": "scfx",
					"nfcNamingCode": "ssc",
					"startEpochMicrosec": 1413378172000000,
					"lastEpochMicrosec": 1413378172000000
				},
				"faultFields": {
					"faultFieldsVersion": 2.0,
					"alarmCondition": "PilotNumberPoolExhaustion",
					"eventSourceType": "other",
					"specificProblem": "Calls cannot complete - pilot numbers are unavailable",
					"eventSeverity": "CRITICAL",
					"vfStatus": "Active",
					"alarmAdditionalInformation": [
						{
							"name": "PilotNumberPoolSize",
							"value": "1000"
						}
					]
				}
			},
			{
				"commonEventHeader": {
					"version": 3.0,
					"domain": "fault",
					"eventName": "Fault\_MobileCallRecording\_RecordingServerUnreachable",
					"eventId": "ab305d54-85b4-a31b-7db2-fb6b9e546025",
					"sequence": 0,
					"priority": "High",
					"reportingEntityId": "cc305d54-75b4-431b-adb2-eb6b9e541234",
					"reportingEntityName": "EricssonOamVf",
					"sourceId": "de305d54-75b4-431b-adb2-eb6b9e546014",
					"sourceName": "scfx0001vm002cap001",
					"nfNamingCode": "scfx",
					"nfcNamingCode": "ssc",
					"startEpochMicrosec": 1413378172000010,
					"lastEpochMicrosec": 1413378172000010
				},
				"faultFields": {
					"faultFieldsVersion": 2.0,
					"alarmCondition": "RecordingServerUnreachable",
					"eventSourceType": "other",
					"specificProblem": "Recording server unreachable",
					"eventSeverity": "CRITICAL",
					"vfStatus": "Active"
				}
			}
			]
		}

Sample Success Response #1
^^^^^^^^^^^^^^^^^^^^^^^^^^

    For success responses without a provided commandList:

	.. code:: bash

		HTTPS/1.1 202 Accepted

Sample Success Response #2
^^^^^^^^^^^^^^^^^^^^^^^^^^

    For success responses with a provided commandList:

	.. code:: bash

		HTTPS/1.1 202 Accepted
		content-type: application/json
		content-length: nnn
		date: Sat, 04 Jul 2015 02:03:15 GMT
		{
			"commandList": [
			{
				"commandType": "throttlingSpecification",
				"eventDomainThrottleSpecification": {
				"eventDomain": "fault",
				"suppressedFieldNames": [
					"alarmInterfaceA",
					"alarmAdditionalInformation"
					]
				}
			},
			{
			"commandType": "throttlingSpecification",
			"eventDomainThrottleSpecification": {
				"eventDomain": "thresholdCrossingAlert",
				"suppressedFieldNames": [
					"associatedAlertIdList",
					"possibleRootCause"
				],
				"suppressedNvPairs" {
					"nvPairFieldName": additionalParameters",
					"suppressedNvPairNames": [
						"someCounterName",
						"someOtherCounterName"
					]
					}
				}
			},
			{
				"commandType": "measurementIntervalChange",
				"measurementInterval": 600
			},
			{
				"commandType": "heartbeatIntervalChange",
				"heartbeatInterval": 90
			},
			{
				"commandType": "provideThrottlingState"
			}
			]
		}

1. .. rubric:: Sample Error Responses

      :name: sample-error-responses-1

2. .. rubric:: Sample Policy Exception

      :name: sample-policy-exception-1

      .. code:: bash

		HTTPS/1.1 400 Bad Request
		content-type: application/json
		content-length: 12345
		Date: Thu, 04 Jun 2009 02:51:59 GMT
		{
			"requestError": {
				"policyException": {
					"messageId": "POL9003",
					"text": "Message content size exceeds the allowable limit",
				}
			}
		}

Sample Service Exception
''''''''''''''''''''''''

	.. code:: bash

		HTTPS/1.1 400 Bad Request
		content-type: application/json
		content-length: 12345
		Date: Thu, 04 Jun 2009 02:51:59 GMT
		{
			"requestError": {
			"serviceException": {
				"messageId": "SVC2000",
				"text": "Missing Parameter: %1. Error code is %2"
				"variables": [
					"severity",
					"400"
				]
				}
			}
		}

Operation: provideThrottlingState
---------------------------------

Functional Behavior
~~~~~~~~~~~~~~~~~~~

Allows authorized event source clients to report the state of event
throttling by event domain that is currently in force in the event
source.

-  Supports only secure HTTPS (one way SSL) access.

-  Uses the HTTP verb POST

-  Supports application/json content types

-  Provides HTTP response codes as well as Service and Policy error
   messages

Call Flow
~~~~~~~~~

|image3|

Figure 4 - provideClientThrottlingState Call Flow

Input Parameters
~~~~~~~~~~~~~~~~

Header Fields (note: all parameter names shall be treated as
case-insensitive):

+------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Parameter**    | **Data Type**   | **Required?**   | **Brief description**                                                                                                                                                                                                                                                                                                                                                                                                                                 |
+------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Accept           | string          | No              | Determines the format of the body of the response. Valid values are:                                                                                                                                                                                                                                                                                                                                                                                  |
|                  |                 |                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|                  |                 |                 | -  application/json                                                                                                                                                                                                                                                                                                                                                                                                                                   |
+------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Authorization    | string          | Yes             | The username and password are formed into one string as "username:password". This string is then Base64 encoded to produce the encoded credential which is communicated in the header after the string "Authorization: Basic ". See examples below. If the Authorization header is missing, then an HTTP 400 Invalid Request message shall be returned. If the string supplied is invalid, then an HTTP 401 Unauthorized message shall be returned.   |
+------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Content-length   | integer         | No              | Note that content length is limited to 1Megabyte.                                                                                                                                                                                                                                                                                                                                                                                                     |
+------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Content-type     | string          | Yes             | Must be set to one of the following values:                                                                                                                                                                                                                                                                                                                                                                                                           |
|                  |                 |                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|                  |                 |                 | -  application/json                                                                                                                                                                                                                                                                                                                                                                                                                                   |
+------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Body Fields:

+------------------------+------------------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Parameter**          | **Data Type**          | **Required?**   | **Brief description**                                                                                                                                              |
+------------------------+------------------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| eventThrottlingState   | eventThrottlingState   | Yes             | Consists of an eventThrottlingMode enumeration which can be 'normal'or 'throttled'followed by an optional array of eventDomainThrottleSpecification structures   |
+------------------------+------------------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Output Parameters
~~~~~~~~~~~~~~~~~

The only output parameters are an HTTP response code and message.

+------------------+-----------------+-----------------+----------------------------------+
| **Parameter**    | **Data Type**   | **Required?**   | **Brief description**            |
+------------------+-----------------+-----------------+----------------------------------+
| Content-length   | integer         | No              | Used only in error conditions.   |
+------------------+-----------------+-----------------+----------------------------------+
| Content-type     | string          | No              | Used only in error conditions.   |
+------------------+-----------------+-----------------+----------------------------------+

Body Fields:

+-----------------+-----------------+-----------------+----------------------------------+
| **Parameter**   | **Data Type**   | **Required?**   | **Brief description**            |
+-----------------+-----------------+-----------------+----------------------------------+
| requestError    | requestError    | No              | Used only in error conditions.   |
+-----------------+-----------------+-----------------+----------------------------------+

HTTP Status Codes
~~~~~~~~~~~~~~~~~

+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| *Code*   | *Reason Phrase*         | *Description*                                                                                                                                                                                                                                                                                                                                                                            |
+==========+=========================+==========================================================================================================================================================================================================================================================================================================================================================================================+
| 204      | No Content              | The throttling state update message has been accepted.                                                                                                                                                                                                                                                                                                                                   |
+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 400      | Bad Request             | Many possible reasons not specified by the other codes (e.g., missing required parameters or incorrect format). The response body may include a further exception code and text. HTTP 400 errors may be mapped to SVC0001 (general service error), SVC0002 (bad parameter), SVC2000 (general service error with details) or PO9003 (message content size exceeds the allowable limit).   |
+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 401      | Unauthorized            | Authentication failed or was not provided. HTTP 401 errors may be mapped to POL0001 (general policy error) or POL2000 (general policy error with details).                                                                                                                                                                                                                               |
+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 404      | Not Found               | The server has not found anything matching the Request-URI. No indication is given of whether the condition is temporary or permanent.                                                                                                                                                                                                                                                   |
+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 405      | Method Not Allowed      | A request was made of a resource using a request method not supported by that resource (e.g., using PUT on a REST resource that only supports POST).                                                                                                                                                                                                                                     |
+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 409      | Locked                  | The request could not be completed due to a conflict with the current state of the resource.                                                                                                                                                                                                                                                                                             |
+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 500      | Internal Server Error   | The server encountered an internal error or timed out; please retry (general catch-all server-side error).HTTP 500 errors may be mapped to SVC1000 (no server resources).                                                                                                                                                                                                                |
+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 503      | Service Unavailable     | The server is currently unable to handle the request due to a temporary overloading or maintenance of the server. The implication is that this is a temporary condition which will be alleviated after some delay.                                                                                                                                                                      |
+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 504      | Gateway Timeout         | The server, while acting as a gateway or proxy, did not receive a timely response from the upstream process.                                                                                                                                                                                                                                                                             |
+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Sample Request and Response
~~~~~~~~~~~~~~~~~~~~~~~~~~~

Sample Request
^^^^^^^^^^^^^^

	.. code:: bash

		POST /eventListener/v5/clientThrottlingState HTTPS/1.1
		Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
		content-type: application/json
		content-length: nnn
		accept: application/json
		{
			"eventThrottlingState": {
				"eventThrottlingMode": "throttled",
				"eventDomainThrottleSpecificationList": [
					{
						"eventDomain": "fault",
						"suppressedFieldNames": [
							"alarmInterfaceA",
							"alarmAdditionalInformation"
						]
					},
					{
						"eventDomain": "thresholdCrossingAlert",
						"suppressedFieldNames": [
							"associatedAlertIdList",
							"possibleRootCause"
						],
						"suppressedNvPairsList": [
							{
								"nvPairFieldName": "additionalParameters",
								"suppressedNvPairNames": [
									"someCounterName",
									"someOtherCounterName"
								]
							}
						]
					}
				]
			}
		}

Sample Success Response
^^^^^^^^^^^^^^^^^^^^^^^

	.. code:: bash

		HTTPS/1.1 204 No Content

1. .. rubric:: Sample Error Responses

      :name: sample-error-responses-2

   1. .. rubric:: Sample Policy Exception

         :name: sample-policy-exception-2

	.. code:: bash

		HTTPS/1.1 400 Bad Request
		content-type: application/json
		content-length: 12345
		Date: Thu, 04 Jun 2009 02:51:59 GMT
		{
			"requestError": {
				"policyException": {
					"messageId": "POL9003",
					"text": "Message content size exceeds the allowable limit",
				}
			}
		}

Sample Service Exception
''''''''''''''''''''''''

	.. code:: bash

		HTTPS/1.1 400 Bad Request
		content-type: application/json
		content-length: 12345
		Date: Thu, 04 Jun 2009 02:51:59 GMT
		{
			"requestError": {
				"serviceException": {
					"messageId": "SVC2000",
					"text": "Missing Parameter: %1. Error code is %2"
					"variables": [
						"severity",
						"400"
					]
				}
			}
		}

.. |image0| image:: ves-rest-resource-structure.png
   :height: 600px
   :width: 800px
.. |image1| image:: ves-publishanyevent.png
   :height: 600px
   :width: 800px
.. |image2| image:: ves-publisheventbatch.png
   :height: 600px
   :width: 800px
.. |image3| image:: ves-providethrottlingstate.png
   :height: 600px
   :width: 800px