Newer
Older
"openapi": "3.1.0",
"info": {
"title": "ETSI GS MEC 029 Fixed Access Information API",
"version": "2.2.1",
"description": "ETSI GS MEC 029 Fixed Access Information API described using OpenAPI.",
"license": {
"name": "BSD-3-Clause",
"url": "https://forge.etsi.org/legal-matters"
"contact": {
"name": "ETSI Forge",
"email": "cti_support@etsi.org",
"url": "https://forge.etsi.org/rep/mec/gs029-fai-api"
}
},
"externalDocs": {
"description": "ETSI GS MEC 029 Fixed Access Information API, v2.2.1",
"url": "https://www.etsi.org/deliver/etsi_gs/MEC/001_099/029/02.02.01_60/gs_mec029v020201p.pdf"
},
"servers": [
{
"url": "https://localhost/fai/v1"
}
],
"tags": [
{
"name": "Queries"
{
"name": "Subscription"
},
{
"name": "Cable line info"
},
{
"name": "Optical network info"
}
],
"paths": {
"/queries/fa_info": {
"get": {
"tags": [
"Queries"
],
"summary": "Retrieve information on the available fixed access networks.",
"description": "Retrieve information on the available fixed access networks.",
"operationId": "fa_infoGET",
"parameters": [
{
"in": "query",
"name": "customerPremisesInfo",
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CpInfo"
"required": false,
"description": "Comma separated list of customer premises information"
},
{
"in": "query",
"name": "lastMileTech",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
"required": false,
"description": "Comma separated list of last mile technologies."
},
{
"in": "query",
"name": "interfaceType",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
"description": "Comma separated list of interface types."
},
{
"in": "query",
"name": "dsbw",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
"required": false,
"description": "Comma separated list of the bandwidth (in Mbps) from the network towards the customer site."
},
{
"in": "query",
"name": "usbw",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
"required": false,
"description": "Comma separated list of the bandwidth (in Mbps) from the customer site towards the network."
},
{
"in": "query",
"name": "latency",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
"required": false,
"description": "Comma separated list of the maximum baseline latency (in ms) between customer site and service edge node."
],
"responses": {
"200": {
"description": "A response body containing the FAI is returned. ",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FaInfo"
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
}
},
"/queries/device_info": {
"get": {
"tags": [
"Queries"
],
"summary": "retrieve information on the devices that are connected to a fixed access network.",
"description": "retrieve information on the devices that are connected to a fixed access network.",
"operationId": "device_infoGET",
"parameters": [
{
"in": "query",
"name": "gwId",
"schema": {
"type": "array",
"items": {
"type": "string"
"required": false,
"description": "Comma separated list of gateway identifier"
},
{
"in": "query",
"name": "deviceId",
"schema": {
"type": "array",
"items": {
"type": "string"
}
"required": false,
"description": "Comma separated list of device identifier."
},
{
"in": "query",
"name": "deviceStatus",
"schema": {
"type": "array",
"items": {
"type": "integer"
}
"description": "Comma separated list of device status."
],
"responses": {
"200": {
"description": "Upon success, a response body containing the information of zero or more devices is returned.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceInfo"
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"406": {
"$ref": "#/components/responses/406"
},
"429": {
"$ref": "#/components/responses/429"
}
},
"/queries/cable_line_info": {
"get": {
"tags": [
"Cable line info"
],
"summary": "It Queries information about the cable line of a fixed access network.",
"description": "It Queries information about the cable line of a fixed access network.",
"operationId": "cable_line_infoGET",
"parameters": [
{
"in": "query",
"name": "customerPremisesInfo",
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CpInfo"
"required": false,
"description": "Comma separated list of customer premises information"
},
{
"in": "query",
"name": "cmId",
"schema": {
"type": "array",
"items": {
"type": "string"
}
"required": false,
"description": "Comma separated list of Cable Modem identifiers."
],
"responses": {
"200": {
"description": "Upon success, a response body containing the information of zero or more cable lines is returned.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CableLineInfo"
"400": {
"$ref": "#/components/responses/400"
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"406": {
"$ref": "#/components/responses/406"
},
"429": {
"$ref": "#/components/responses/429"
}
},
"/queries/optical_network_info": {
"get": {
"tags": [
"Optical network info"
],
"summary": "used to query information about the optical network.",
"description": "used to query information about the optical network.",
"operationId": "optical_network_infoGET",
"in": "query",
"name": "customerPremisesInfo",
"type": "array",
"items": {
"$ref": "#/components/schemas/CpInfo"
"required": false,
"description": "Comma separated list of customer premises information"
},
{
"in": "query",
"name": "ponYS_ID",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"required": false,
"description": "Comma separated list of optical system identifiers."
},
{
"in": "query",
"name": "onuId",
"schema": {
"type": "array",
"items": {
"type": "string"
}
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
"required": false,
"description": "Comma separated list of optical network unit identifiers."
}
],
"responses": {
"200": {
"description": "Upon success, a response body containing the information of zero or more optical networks is returned",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PonInfo"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"406": {
"$ref": "#/components/responses/406"
},
"429": {
"$ref": "#/components/responses/429"
}
}
}
},
"/subscriptions": {
"get": {
"tags": [
"Subscription"
],
"summary": "request information about the subscriptions for this requestor.",
"description": "request information about the subscriptions for this requestor.",
"operationId": "subGET",
"parameters": [
{
"in": "query",
"name": "subscription_type",
"schema": {
"type": "string"
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
"required": false,
"description": "Query parameter to filter on a specific subscription type. Permitted values onu_alarm Optical Network Unit alarm device_abnormal_alert Device abnormal alert - cm_connectivity_state Cable Modem connectivity state - ani_alarm Access Node Interface alarm"
}
],
"responses": {
"200": {
"description": "A response body containing the list of links to requestor subscriptions is returned.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionLinkList"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"406": {
"$ref": "#/components/responses/406"
},
"429": {
"$ref": "#/components/responses/429"
}
}
},
"post": {
"tags": [
"Subscription"
],
"summary": " create a new subscription to FAI notifications.",
"description": " create a new subscription to FAI notifications.",
"operationId": "subPOST",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/OnuAlarmSubscription"
},
{
"$ref": "#/components/schemas/DevInfoSubscription"
},
{
"$ref": "#/components/schemas/CmConnSubscription"
},
{
"$ref": "#/components/schemas/AniAlarmSubscription"
}
]
}
"responses": {
"201": {
"description": "In the returned NotificationSubscription structure, the created subscription is described using the appropriate data type.",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/OnuAlarmSubscription"
},
{
"$ref": "#/components/schemas/DevInfoSubscription"
},
{
"$ref": "#/components/schemas/CmConnSubscription"
},
{
"$ref": "#/components/schemas/AniAlarmSubscription"
}
]
}
}
}
},
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
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"406": {
"$ref": "#/components/responses/406"
},
"415": {
"$ref": "#/components/responses/415"
},
"422": {
"$ref": "#/components/responses/422"
},
"429": {
"$ref": "#/components/responses/429"
}
},
"callbacks": {
"notification": {
"{$request.body#/callbackReference}": {
"post": {
"summary": "Callback POST used to send a notification",
"description": "A notification from FAIS.",
"operationId": "notificationPOST",
"requestBody": {
"description": "Subscription notification",
"required": true,
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/OnuAlarmNotification"
},
{
"$ref": "#/components/schemas/DevInfoNotification"
},
{
"$ref": "#/components/schemas/CmConnNotification"
},
{
"$ref": "#/components/schemas/AniAlarmNotification"
}
]
}
}
},
"responses": {
"204": {
"$ref": "#/components/responses/204"
}
}
}
}
}
}
}
},
"/subscriptions/{subscriptionId}": {
"parameters": [
{
"in": "path",
"name": "subscriptionId",
"description": "Refers to created subscription, where the FAI API allocates a unique resource name for this subscription",
"schema": {
"type": "string"
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
"required": true
}
],
"get": {
"tags": [
"Subscription"
],
"summary": "Retrieve information about this subscription.",
"description": "Retrieve information about this subscription.",
"operationId": "individualSubscriptionGET",
"responses": {
"200": {
"description": "A response body containing data type describing the specific FAI event subscription is returned",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/OnuAlarmSubscription"
},
{
"$ref": "#/components/schemas/DevInfoSubscription"
},
{
"$ref": "#/components/schemas/CmConnSubscription"
},
{
"$ref": "#/components/schemas/AniAlarmSubscription"
}
]
}
}
"400": {
"$ref": "#/components/responses/400"
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
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"406": {
"$ref": "#/components/responses/406"
},
"429": {
"$ref": "#/components/responses/429"
}
}
},
"put": {
"tags": [
"Subscription"
],
"summary": "Used to update the existing subscription.",
"description": "Used to update the existing subscription.",
"operationId": "individualSubscriptionPUT",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/OnuAlarmSubscription"
},
{
"$ref": "#/components/schemas/DevInfoSubscription"
},
{
"$ref": "#/components/schemas/CmConnSubscription"
},
{
"$ref": "#/components/schemas/AniAlarmSubscription"
}
]
"responses": {
"200": {
"description": "A response body containing data type describing the updated subscription is returned",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/OnuAlarmSubscription"
},
{
"$ref": "#/components/schemas/DevInfoSubscription"
},
{
"$ref": "#/components/schemas/CmConnSubscription"
},
{
"$ref": "#/components/schemas/AniAlarmSubscription"
}
]
}
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
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"406": {
"$ref": "#/components/responses/406"
},
"412": {
"$ref": "#/components/responses/412"
},
"422": {
"$ref": "#/components/responses/422"
},
"429": {
"$ref": "#/components/responses/429"
}
}
},
"delete": {
"tags": [
"Subscription"
],
"summary": "Used to cancel the existing subscription.",
"description": "Used to cancel the existing subscription.",
"operationId": "individualSubscriptionDELETE",
"responses": {
"204": {
"$ref": "#/components/responses/204"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"429": {
"$ref": "#/components/responses/429"
}
}
}
}
},
"components": {
"schemas": {
"AniAlarmNotification.alarm": {
"description": "Indicates the alarm of the ANI: 0 = LowReceivedOpticalPower. 1 = HighReceivedOpticalPower. 2 = SignalFailure. 3 = SignalDegrade. 4 = LowTransmitOpticalPower.5 = HighTransmitOpticalPower.6 = LaserBiasCurrent.",
"enum": [
0,
1,
2,
3,
4,
5,
6
],
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Enum"
},
"AniAlarmNotification.aniId": {
"properties": {
"onuId": {
"description": "The unique identifiers for the optical network unit.",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
},
"aniIndex": {
"description": "The index of an access network interface supported by the optical network unit.",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
}
"required": [
"onuId",
"aniIndex"
]
},
"AniAlarmNotification": {
"properties": {
"alarm": {
"$ref": "#/components/schemas/AniAlarmNotification.alarm"
},
"aniId": {
"$ref": "#/components/schemas/AniAlarmNotification.aniId"
},
"customerPremisesInfo": {
"description": "The physical location of the related customer sites.",
"items": {
"$ref": "#/components/schemas/CpInfo"
"type": "array",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "CpInfo"
"notificationType": {
"description": "Shall be set to \"AniAlarmNotification\".",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
},
"onuId": {
"type": "string"
},
"timeStamp": {
"$ref": "#/components/schemas/TimeStamp"
}
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
"required": [
"notificationType",
"aniIndex",
"alarm"
],
"type": "object",
"x-etsi-ref": "6.4.6"
},
"AniAlarmSubscription.filterCriteriaAniAlarm.alarms": {
"description": "In case alarms is not included in the subscription request, the default value -1 = All shall be used and included in the response:\n0 =\tLowReceivedOpticalPower.\n(Received downstream optical power below threshold.)\n1 =\tHighReceivedOpticalPower.\n\t(Received downstream optical power above threshold.)\n2 =\tSignalFalure.\n(Bit error-based signal fail.)\n3 =\tSignalDegrade.\n(Bit error-based signal degrade.)\n4 =\tLowTransmitOpticalPower.\n(Transmit optical power below lower threshold.)\n5 =\tHighTransmitOpticalPower.\n(Transmit optical power above upper threshold.)\n6 =\tLaserBiasCurrent.\n(Laser bias current above threshold determined by vendor.)\n-1 =\tAll.",
"enum": [
0,
1,
2,
3,
4,
5,
6,
-1
],
"type": "integer"
},
"AniAlarmSubscription.links": {
"properties": {
"self": {
"$ref": "#/components/schemas/LinkType"
}
"required": [
"self"
]
},
"AniAlarmSubscription.filterCriteriaAniAlarm": {
"description": "List of filtering criteria for the subscription. Any filtering criteria from below, which is included in the request, shall also be included in the response.",
"required": [
"onuId",
"aniId"
],
"properties": {
"customerPremisesInfo": {
"required": [
"onuId",
"aniId"
],
"description": "0 to N physical locations of the customer sites.",
"type": "array",
"items": {
"$ref": "#/components/schemas/CpInfo"
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "CpInfo"
},
"onuId": {
"description": "1 to N unique identifiers for the optical network units. Typical it is the unique serial number for each ONU, which contains the vendor ID and version number. The first four bytes are an ASCII-encoded four-letter vendor ID. The second four bytes are a binary encoded serial number, under the control of the ONU vendor.",
"type": "array",
"items": {
"x-etsi-mec-cardinality": "1..N",
"x-etsi-mec-origin-type": "String"
}
},
"aniId": {
"description": "",
"type": "object",
"required": [
"onuId",
"aniIndex"
],
"properties": {
"onuId": {
"description": "The unique identifiers for the optical network unit",
"type": "string"
},
"aniIndex": {
"description": "The index of an access network interface supported by the optical network unit",
"type": "string"
"alarms": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AniAlarmSubscription.filterCriteriaAniAlarm.alarms"
}
}
},
"AniAlarmSubscription": {
"properties": {
"subscriptionType": {
"description": "Shall be set to \\\"AniAlarmSubscription\\\"",
"type": "string"
},
"_links": {
"$ref": "#/components/schemas/AniAlarmSubscription.links"
},
"aniIndex": {
"description": "The index of an access network interface supported by the optical network unit.",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
"callbackReference": {
"description": "URI exposed by the client on which to receive notifications via HTTP. At least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to FAIS to choose an alternative and return only that alternative in the response, as described in ETSI GS MEC 009, clause 6.12a.",
"format": "uri",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "URI"
},
"requestTestNotification": {
"description": "Shall be set to TRUE by the service consumer to request",
"type": "boolean"
},
"websockNotifConfig": {
"description": "Provides details to negotiate and signal the use of a Websocket connection between FAIS and the service consumer for notifications. At least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to FAIS to choose an alternative and return only that alternative in the response, as described in ETSI GS MEC 009, clause 6.12a.",
"$ref": "#/components/schemas/WebsockNotifConfig"
},
"expiryDeadline": {
"$ref": "#/components/schemas/TimeStamp"
},
"filterCriteriaAniAlarm": {
"$ref": "#/components/schemas/AniAlarmSubscription.filterCriteriaAniAlarm"
}
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
"required": [
"subscriptionType",
"callbackReference",
"filterCriteriaAniAlarm",
"onuId",
"aniIndex"
],
"type": "object",
"x-etsi-ref": "6.3.6"
},
"CableLineInfo.cmStatus": {
"description": "It provides CM connectivity status information of the CM.",
"type": "object",
"required": [
"ifIndex",
"cmRegState",
"resets",
"lostSyncs",
"invalidRegRsps",
"energyMgt1x1OperStatus",
"emDlsOperStatus"
],
"properties": {
"ifIndex": {
"description": "It denotes the MAC Domain interface index of the CM.",
"type": "string"
},
"cmRegState": {
"type": "integer",
"description": "It indicates the CM connectivity state. Enumeration of: 1 = notReady. 2 = notSynchronized. 3 = phySynchronized. 4 = dsTopologyResolutionInProgress.5 = usParametersAcquired. 6 = rangingInProgress.7 = rangingComplete. 8 = eaeInProgress.9 = dhcpv4InProgress. 10 = dhcpv6InProgress.11 = dhcpV4Complete.12 = dhcpV6Complete.13 = todEstablished.14 = securityEstablished.15 = configFileDownloadComplete.16 = registrationInProgress.17 = registrationComplete. 18 = accessDenied. 19 =operational. 20 = bpiInit.21 =forwardingDisabled. 22 = rangingInProgress. 23 = rfMuteAll.",
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23
]
},
"resets": {
"description": "It denotes the number of times the CM reset or initialized this interface.",
"type": "integer"
},
"lostSyncs": {
"description": "It denotes the number of times the CM lost synchronization with the downstream channel.",
"type": "integer"
},
"invalidRegRsps": {
"description": "It denotes the number of times the CM received invalid registration response messages.",
"type": "integer"
},
"energyMgt1x1OperStatus": {
"description": "It indicates whether the CM is currently operating in Energy Management 1x1 Mode.",
"type": "boolean"
},
"emDlsOperStatus": {
"description": "It indicates whether the CM is currently operating in Energy Management DLS Mode.",
"type": "boolean"
}
}
},
"CableLineInfo.cmDpvStats": {
"required": [
"ifIndex",
"lastMeasLatency",
"lastMeasTime",
"minLatency",
"maxLatency",
"avgLatency",
"numMeas"
],
"properties": {
"ifIndex": {
"description": "It represents the interface Index of the Downstream Interface where the measurements are taken.",
"type": "string"
},
"lastMeasLatency": {
"description": "The last latency measurement",
"type": "integer"
},
"lastMeasTime": {
"$ref": "#/components/schemas/TimeStamp"
},
"minLatency": {
"description": "The minimum latency measurement.",
"type": "integer"
},
"maxLatency": {
"description": "The maximum latency measurement.",
"type": "integer"
},
"avgLatency": {
"description": "The average latency measurement.",
"type": "integer"
},
"numMeas": {
"description": "The number of latency measurements made.",
"type": "integer"
}
}
},
"CableLineInfo.serviceFlowStats.serviceFlowInfo": {
"type": "object",
"required": [
"serviceFlowId",
"description",
"timeCreated",
"timeActive",
"policedDropPkts",
"policedDelayPkts",
"aqmDroppedPkts"
],
"properties": {
"serviceFlowId": {
"description": "It represents an identifier assigned to a Service Flow by CMTS within a MAC Domain.",
"type": "integer"
},
"pkts": {
"description": "For outgoing Service Flows, this attribute counts the number of Packet Data PDUs forwarded to this Service Flow. For incoming upstream CMTS service flows, this attribute counts the number of Packet Data PDUs actually received on the Service Flow identified by the SID for which the packet was scheduled.",
"type": "integer"
},
"timeCreated": {
"description": "For outgoing Service Flows, this attribute counts the number of Packet Data PDUs forwarded to this Service Flow. For incoming upstream CMTS service flows, this attribute counts the number of Packet Data PDUs actually received on the Service Flow identified by the SID for which the packet was scheduled.",
"$ref": "#/components/schemas/TimeStamp"
},
"timeActive": {
"description": "FIt indicates the number of seconds that the service flow has been active",
"type": "integer"
},
"policedDropPkts": {
"description": "For upstream service flows, this attribute counts the number of Packet Data PDUs classified to this service flow dropped due to 1) exceeding the selected Buffer Size for the service flow; or 2) UGS packets dropped due to exceeding the Unsolicited Grant Size with a Request/Transmission policy that requires such packets to be dropped.",
"type": "integer"
},
"policedDelayPkts": {
"description": "It counts only outgoing packets delayed in order to maintain the Maximum Sustained Traffic Rate.",
"type": "integer"
},
"aqmDroppedPkts": {
"description": "For upstream service flows on which AQM is enabled, this attribute counts the number of Packet Data PDUs classified to this service flow dropped due to Active Queue Management drop decisions.",
"type": "integer"
}
}
},
"CableLineInfo.serviceFlowStats": {
"type": "object",
"required": [
"ifIndex",
"serviceFlowInfo"
],
"ifIndex": {
"description": "It represents the interface index of the MAC Domain of the Service Flow.",
"type": "string"
"serviceFlowInfo": {
"description": "It represents the information of a Service Flow.",
"type": "array",
"$ref": "#/components/schemas/CableLineInfo.serviceFlowStats.serviceFlowInfo"
}
}
},
"CableLineInfo": {
"type": "object",
"required": [
"customerPremisesInfo",
"cmId"
],
"properties": {
"timeStamp": {
"$ref": "#/components/schemas/TimeStamp"
"customerPremisesInfo": {
"$ref": "#/components/schemas/CpInfo"
"cmId": {
"type": "string",
"description": "Information (typically the serial number) to identify a Cable Modem at subscriber locations intended for use in conveying data communications on a cable data system. This value SHALL remain fixed over the lifetime of the device, including across firmware updates."
"cmStatus": {
"$ref": "#/components/schemas/CableLineInfo.cmStatus"
"cmDpvStats": {
"$ref": "#/components/schemas/CableLineInfo.cmDpvStats"
},
"serviceFlowStats": {
"$ref": "#/components/schemas/CableLineInfo.serviceFlowStats"
}
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
"x-etsi-ref": "6.2.4"
},
"CmConnNotification.cmIf.cmRegState": {
"description": "It indicates the CM connectivity state. Enumeration of 1 = notReady. 2 = notSynchronized. 3 = phySynchronized. 4 = dsTopologyResolutionInProgress.5 = usParametersAcquired. 6 = rangingInProgress.7 = rangingComplete. 8 = eaeInProgress.9 = dhcpv4InProgress. 10 = dhcpv6InProgress.11 = dhcpV4Complete.12 = dhcpV6Complete.13 = todEstablished.14 = securityEstablished.15 = configFileDownloadComplete.16 = registrationInProgress.17 = registrationComplete. 18 = accessDenied. 19 =operational. 20 = bpiInit.21 =forwardingDisabled. 22 = rangingInProgress. 23 = rfMuteAll.",
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21
],
"type": "integer"
},
"CmConnNotification.cmIf": {
"description": "",
"items": {
"type": "object"
"properties": {
"cmId": {
"description": "The Cable Modem identifier.",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
"cmRegState": {
"items": {
"$ref": "#/components/schemas/CmConnNotification.cmIf.cmRegState"
},
"minItems": 1,
"type": "array",
"x-etsi-mec-cardinality": "1..N",
"x-etsi-mec-origin-type": "Enum"
"ifIndex": {
"description": "The MAC Domain interface index of the CM.",
"items": {
"type": "string"
"minItems": 1,
"type": "array",
"x-etsi-mec-cardinality": "1..N",
"x-etsi-mec-origin-type": "String"
}
"required": [
"cmId",
"ifIndex",
"cmRegState"
]
},
"CmConnNotification": {
"required": [
"notificationType",
"cmIf"
],
"properties": {
"cmIf": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CmConnNotification.cmIf"
"customerPremisesInfo": {
"$ref": "#/components/schemas/CpInfo"
},
"notificationType": {
"description": "Shall be set to \\\"CmconnNotification\\\".",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
"timeStamp": {
"$ref": "#/components/schemas/TimeStamp"
}
"type": "object",
"x-etsi-ref": "6.4.4"
},
"CmConnSubscription.links": {
"description": "Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests.",
"properties": {
"self": {
"$ref": "#/components/schemas/LinkType"
}
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
"required": [
"self"
],
"type": "object",
"x-etsi-mec-cardinality": "0..1"
},
"CmConnSubscription.filterCriteriaCmConn.cmIf.cmRegState": {
"description": "It indicates the CM connectivity state. Enumeration of: 1 = notReady. 2 = notSynchronized. 3 = phySynchronized. 4 = dsTopologyResolutionInProgress.5 = usParametersAcquired. 6 = rangingInProgress.7 = rangingComplete. 8 = eaeInProgress.9 = dhcpv4InProgress. 10 = dhcpv6InProgress.11 = dhcpV4Complete.12 = dhcpV6Complete.13 = todEstablished.14 = securityEstablished.15 = configFileDownloadComplete.16 = registrationInProgress.17 = registrationComplete. 18 = accessDenied. 19 =operational. 20 = bpiInit.21 =forwardingDisabled.",
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21
],
"type": "integer"
},
"CmConnSubscription.filterCriteriaCmConn.cmIf": {
"description": "",
"properties": {
"cmId": {
"description": "The identifier of a Cable Modem at subscriber locations intended for use in conveying data communications on a cable data system.",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
"cmRegState": {
"items": {
"$ref": "#/components/schemas/CmConnSubscription.filterCriteriaCmConn.cmIf.cmRegState"
},
"minItems": 1,
"type": "array",
"x-etsi-mec-cardinality": "1..N",
"x-etsi-mec-origin-type": "Enum"
},
"ifIndex": {
"description": "The MAC Domain interface index of the CM.",
"items": {
"type": "string"
"minItems": 1,
"type": "array",
"x-etsi-mec-cardinality": "1..N",
"x-etsi-mec-origin-type": "String"
}
},
"required": [
"cmId",
"ifIndex",
"cmRegState"
]
},
"CmConnSubscription.filterCriteriaCmConn": {
"description": "List of filtering criteria for the subscription. Any filtering criteria from below, which is included in the request, shall also be included in the response.",
"properties": {
"cmIf": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CmConnSubscription.filterCriteriaCmConn.cmIf"
"customerPremisesInfo": {
"$ref": "#/components/schemas/CpInfo"
}
"type": "object",
"x-etsi-mec-cardinality": "1"
},
"CmConnSubscription": {
"properties": {
"_links": {
"$ref": "#/components/schemas/CmConnSubscription.links"
},
"callbackReference": {
"description": "URI exposed by the client on which to receive notifications via HTTP. At least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to FAIS to choose an alternative and return only that alternative in the response, as described in ETSI GS MEC 009, clause 6.12a.",
"format": "uri",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "URI"
"requestTestNotification": {
"description": "Shall be set to TRUE by the service consumer to request",
"type": "boolean"
},
"websockNotifConfig": {
"description": "Provides details to negotiate and signal the use of a Websocket connection between FAIS and the service consumer for notifications. At least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to FAIS to choose an alternative and return only that alternative in the response, as described in ETSI GS MEC 009, clause 6.12a.",
"$ref": "#/components/schemas/WebsockNotifConfig"
},
"expiryDeadline": {
"$ref": "#/components/schemas/TimeStamp"
},
"filterCriteriaCmConn": {
"$ref": "#/components/schemas/CmConnSubscription.filterCriteriaCmConn"
},
"subscriptionType": {
"description": "Shall be set to \"CmConnSubscription\".",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
}
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
"required": [
"subscriptionType",
"filterCriteriaCmConn"
],
"type": "object",
"x-etsi-notes": "NOTE:\t'notReady' indicates that the CM has not started the registration process yet.\n\t'notSynchronized' indicates that the CM has not initiated or completed the synchronization of the downstream physical layer.\n\t'phySynchronized' indicates that the CM has completed the synchronization of the downstream physical layer.\n\t'dsTopologyResolutionInProgress' indicates that the CM is attempting to determine its MD-DS-SG.\n\t'usParametersAcquired' indicates that the CM has completed the upstream parameters acquisition or have completed the downstream and upstream service groups resolution.\n\t'rangingInProgress' indicates that the CM has initiated the initial ranging process.\n\t'rangingComplete' indicates that the CM has completed initial ranging and received a Ranging Status of success from the CMTS in the RNG-RSP message.\n\t'eaeInProgress' indicates that the CM has sent an Auth Info message for EAE.\n\t'dhcpv4InProgress' indicates that the CM has sent a DHCPv4 DISCOVER to gain IP connectivity.\n\t'dhcpv6InProgress' indicates that the CM has sent a DHCPv6 Solicit message.\n\t'dhcpv4Complete' indicates that the CM has received a DHCPv4 ACK message from the CMTS.\n\t'dhcpv6Complete' indicates that the CM has received a DHCPv6 Reply message from the CMTS.\n\t'todEstablished' indicates that the CM has successfully acquired time of day.\n\t'securityEstablished' indicates that the CM has successfully completed the BPI initialization process.\n\t'configFileDownloadComplete' indicates that the CM has completed the config file download process.\n\t'registrationInProgress' indicates that the CM has sent a Registration Request.\n\t'registrationComplete' indicates that the CM has successfully completed the Registration process with the CMTS.\n\t'accessDenied' indicates that the CM has received a registration aborted notification from the CMTS.\n\t'operational' indicates that the CM has completed all necessary initialization steps and is operational.\n\t'bpiInit' indicates that the CM has started the BPI initialization process as indicated in the CM config file.\n\t'forwardingDisabled' indicates that the registration process was completed, but the network access option in the received configuration file prohibits forwarding.",
"x-etsi-ref": "6.3.4"
},
"CpInfo": {
"properties": {
"latitude": {
"description": "Latitude (DATUM=WGS84) -90 to 90 in decimal degree format DDD.ddd",
"format": "Float",
"type": "number",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Float"
},
"longitude": {
"description": "Longitude (DATUM=WGS84) -180 to 180 in decimal degree format DDD.ddd",
"format": "Float",
"type": "number",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Float"
},
"postalCode": {
"description": "Postal code for the location",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
}
"type": "object",
"x-etsi-ref": "6.5.3"
},
"DevInfoNotification": {
"properties": {
"deviceErrStatus": {
"$ref": "#/components/schemas/deviceErrStatus"
},
"deviceId": {
"description": "The identifier for a device.",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
},
"notificationType": {
"description": "Shall be set to \"DevInfoNotification\".",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
"timeStamp": {
"$ref": "#/components/schemas/TimeStamp"
}
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
"required": [
"notificationType",
"deviceId",
"deviceErrStatus"
],
"type": "object",
"x-etsi-ref": "6.4.3"
},
"deviceErrStatus": {
"description": "The abnormal operational status of the device. Enumeration of: 1 = Error. 2 = Disabled.",
"enum": [
1,
2
],
"type": "integer"
},
"DevInfoSubscription.links": {
"description": "Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests.",
"properties": {
"self": {
"$ref": "#/components/schemas/LinkType"
}
"required": [
"self"
],
"type": "object",
"x-etsi-mec-cardinality": "0..1"
},
"DevInfoSubscription.filterCriteriaDevInfo": {
"description": "List of filtering criteria for the subscription. Any filtering criteria from below, which is included in the request, shall also be included in the response.",
"properties": {
"deviceErrStatus": {
"items": {
"$ref": "#/components/schemas/deviceErrStatus"
"type": "array",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "Enum"
},
"deviceId": {
"description": "The device identifier.",
"items": {
"type": "string"
"type": "array",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "String"
"gwId": {
"description": "The identifier of an Internet Gateway Device through which the customer premises device is connected.",
"items": {
"type": "string"
},
"type": "array",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "String"
}
"type": "object",
"x-etsi-mec-cardinality": "1"
},
"DevInfoSubscription": {
"properties": {
"_links": {
"$ref": "#/components/schemas/DevInfoSubscription.links"
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
"callbackReference": {
"description": "URI exposed by the client on which to receive notifications via HTTP. At least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to FAIS to choose an alternative and return only that alternative in the response, as described in ETSI GS MEC 009, clause 6.12a.",
"format": "uri",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "URI"
},
"requestTestNotification": {
"description": "Shall be set to TRUE by the service consumer to request",
"type": "boolean"
},
"websockNotifConfig": {
"description": "Provides details to negotiate and signal the use of a Websocket connection between FAIS and the service consumer for notifications. At least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to FAIS to choose an alternative and return only that alternative in the response, as described in ETSI GS MEC 009, clause 6.12a.",
"$ref": "#/components/schemas/WebsockNotifConfig"
},
"expiryDeadline": {
"$ref": "#/components/schemas/TimeStamp"
},
"filterCriteriaDevInfo": {
"$ref": "#/components/schemas/DevInfoSubscription.filterCriteriaDevInfo"
},
"subscriptionType": {
"description": "Shall be set to \"DevInfoSubscription\".",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
}
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
"required": [
"subscriptionType",
"callbackReference",
"filterCriteriaDevInfo"
],
"type": "object",
"x-etsi-ref": "6.3.3"
},
"DeviceInfo.deviceStatus": {
"description": "Current operational status of the device. Enumeration of: 1 = Up. 2 = Initializing. 3 = Error. 4 = Disabled.",
"enum": [
1,
2,
3,
4
],
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Enum"
},
"DeviceInfo": {
"properties": {
"deviceId": {
"description": "Typically, the serial number of the device.This value shall remain fixed over the lifetime of the device, including across firmware updates.",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
},
"deviceStatus": {
"$ref": "#/components/schemas/DeviceInfo.deviceStatus"
},
"downloadDiagnostics": {
"$ref": "#/components/schemas/DownloadDiagnostics"
},
"gwId": {
"description": "Information (typically the serial number) to identify an Internet Gateway Device through which the customer premises device is connected. This value shall remain fixed over the lifetime of the device, including across firmware updates.",
"items": {
"type": "string"
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
"minItems": 1,
"type": "array",
"x-etsi-mec-cardinality": "1..N",
"x-etsi-mec-origin-type": "String"
},
"iPConnectionUpTime": {
"description": "The time in seconds that the IP interface has been connected.",
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Integer"
},
"iPPingDiagnostics": {
"$ref": "#/components/schemas/IPPingDiagnostics"
},
"timeStamp": {
"$ref": "#/components/schemas/TimeStamp"
},
"totalBytesReceived": {
"description": "Total number of IP payload bytes received since the device was last restarted.",
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Integer"
},
"totalBytesSent": {
"description": "Total number of IP payload bytes sent since the device was last restarted.",
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Integer"
},
"totalPacketsReceived": {
"description": "Total number of packets received since the device was last restarted.",
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Integer"
},
"totalPacketsSent": {
"description": "Total number of packets sent since the device was last restarted.",
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Integer"
},
"traceRouteDiagnostics": {
"$ref": "#/components/schemas/TraceRouteDiagnostics"
"upTime": {
"description": "Time in seconds since the device was last restarted.",
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Integer"
},
"uploadDiagnostics": {
"$ref": "#/components/schemas/UploadDiagnostics"
}
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
"required": [
"gwId",
"deviceId",
"deviceStatus",
"upTime",
"iPConnectionUpTime",
"totalBytesSent",
"totalBytesReceived",
"totalPacketsSent",
"totalPacketsReceived"
],
"type": "object",
"x-etsi-ref": "6.2.3"
},
"DownloadDiagnostics.diagnosticsState": {
"description": "The state of the HTTP and FTP download test. Enumeration of:1 = None.2 = Requested.3 = Completed.4 = Error_InitConnectionFailed.5 = Error_NoResponse.6 = Error_TransferFailed. 7 = Error_PasswordRequestFailed.8 = Error_LoginFailed.9 = Error_NoTransferMode.10 = Error_NoPASV.11 = Error_IncorrectSize.12 = Error_Timeout.",
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12
],
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Enum"
},
"DownloadDiagnostics": {
"properties": {
"bOMTime": {
"$ref": "#/components/schemas/TimeStamp"
},
"diagnosticsState": {
"$ref": "#/components/schemas/DownloadDiagnostics.diagnosticsState"
},
"downloadURI": {
"description": "The URI for the device to perform the download on.",
"format": "uri",
"type": "uri",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "URI"
},
"eOMTime": {
"$ref": "#/components/schemas/TimeStamp"
},
"rOMTime": {
"$ref": "#/components/schemas/TimeStamp"
},
"tCPOpenReponseTime": {
"$ref": "#/components/schemas/TimeStamp"
},
"tCPOpenRequestTime": {
"$ref": "#/components/schemas/TimeStamp"
},
"testBytesReceived": {
"description": "The test traffic received in bytes during the FTP/HTTP transaction including FTP/HTTP headers, between bOMTime and eOMTime.",
"type": "integer",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Integer"
},
"totalBytesReceived": {
"description": "The total number of bytes received on the Interface between bOMTime and eOMTime.",
"type": "integer",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Integer"
}
"required": [
"diagnosticsState"
],
"type": "object",
"x-etsi-ref": "6.5.6"
},
"ExpiryNotification.links": {
"description": "List of hyperlinks related to the resource.",
"properties": {
"self": {
"description": "Self referring URI. This shall be included in the response from the FAIS. The URI shall be unique within the FAI API as it acts as an ID for the subscription.",
"format": "uri",
"type": "uri",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "URI"
}
"required": [
"self"
],
"type": "object",
"x-etsi-mec-cardinality": "1"
},
"ExpiryNotification": {
"properties": {
"_links": {
"$ref": "#/components/schemas/ExpiryNotification.links"
"expiryDeadline": {
"$ref": "#/components/schemas/TimeStamp"
"timeStamp": {
"$ref": "#/components/schemas/TimeStamp"
}
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
"required": [
"_links",
"expiryDeadline"
],
"type": "object",
"x-etsi-ref": "6.4.5"
},
"FaInfo.connectivityInfo.interfaceType": {
"description": "The physical interface used for the end customer site:1 = 100BASE-TX.2 = 1000BASE-TX.3 = 1000BASE-LX.4 = 1000BASELX10.5 = 1000BASEBX10. 6 = 1000BASE-LH.7 = 1000Base-ZX. 8 = ADSL-RJ11.9 = VDSL-RJ11.10 = GPON.",
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10
],
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Enum"
},
"FaInfo.connectivityInfo.lastMileTech": {
"description": "An informative field identifying the last mile access technology used.The valid values are:1 = ADSL.2 = VDSL.3 = GPON. 4 = XGPON.5 = NGPON2. 6 = XGSPON. 7 = GFAST.8 = P2PEthernet.",
"enum": [
1,
2,
3,
4,
5,
6,
7,
8
],
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Enum"
},
"FaInfo.connectivityInfo": {
"description": "The per connectivity domain FAI as defined below.",
"properties": {
"dsbw": {
"description": "The bandwidth (in Mbps) from the network towards the customer site.",
"type": "integer",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Integer"
},
"interfaceType": {
"$ref": "#/components/schemas/FaInfo.connectivityInfo.interfaceType"
},
"lastMileTech": {
"$ref": "#/components/schemas/FaInfo.connectivityInfo.lastMileTech"
},
"latency": {
"description": "Maximum baseline latency (in ms) between customer site and service edge node.",
"type": "integer",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Integer"
},
"usbw": {
"description": "The bandwidth (in Mbps) from the customer site towards the network.",
"type": "integer",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Integer"
}
"required": [
"lastMileTech",
"interfaceType"
]
},
"FaInfo": {
"properties": {
"connectivityInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FaInfo.connectivityInfo"
"customerPremisesInfo": {
"description": "The physical location of a customer site.",
"items": {
"$ref": "#/components/schemas/CpInfo"
"minItems": 1,
"type": "array",
"x-etsi-mec-cardinality": "1..N",
"x-etsi-mec-origin-type": "CpInfo"
"timeStamp": {
"$ref": "#/components/schemas/TimeStamp"
}
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
"type": "object",
"required": [
"customerPremisesInfo"
],
"x-etsi-ref": "6.2.2"
},
"IPPingDiagnostics.diagnosticsState": {
"description": "The state of the IP ping test. Enumeration of: 1 = None. 2 = Requested. 3 = Complete. 4 = Error_CannotResolveHostName. 5 = Error_Internal.6 = Error_Other.",
"enum": [
1,
2,
3,
4,
5,
6
],
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Enum"
},
"IPPingDiagnostics": {
"properties": {
"averageResponseTime": {
"description": "Result parameter indicating the average response time in milliseconds over all repetitions with successful responses of the most recent ping test.\n\nIf there were no successful responses, this value shall be zero.",
"type": "integer",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Integer"
},
"dataBlockSize": {
"description": "Size of the data block in bytes to be sent for each ping.",
"type": "integer",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Integer"
},
"diagnosticsState": {
"$ref": "#/components/schemas/IPPingDiagnostics.diagnosticsState"
},
"failureCount": {
"description": "Result parameter indicating the number of failed pings in the most recent ping test.",
"type": "integer",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Integer"
},
"host": {
"description": "Host name or address of the host to ping.",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
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
"maximumResponseTime": {
"description": "Result parameter indicating the maximum response time in milliseconds over all repetitions with successful responses of the most recent ping test.\n\nIf there were no successful responses, this value shall be zero.",
"type": "integer",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Integer"
},
"minimumResponseTime": {
"description": "Result parameter indicating the minimum response time in milliseconds over all repetitions with successful responses of the most recent ping test.\n\nIf there were no successful responses, this value shall be zero.",
"type": "integer",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Integer"
},
"numberOfRepetitions": {
"description": "Number of repetitions of the ping test to perform before reporting the results.",
"type": "integer",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Integer"
},
"successCount": {
"description": "Result parameter indicating the number of successful\npings (those in which a successful response was received prior to the timeout) in the most recent ping test.",
"type": "integer",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Integer"
},
"timeout": {
"description": "Timeout in milliseconds for the ping test.",
"type": "integer",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Integer"
}
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
"required": [
"diagnosticsState"
],
"type": "object",
"x-etsi-ref": "6.5.4"
},
"OnuAlarmNotification.alarm": {
"description": "Indicates the alarm of the ONU:0 = EquipmentAlarm.1 = PoweringAlarm.2 = BatteryMissing.3 = BatteryFailure.4 = BatteryLow.5 = PhysicalIntrusion. 6 = OnuSelfTestFailure. 7 = DyingGasp. 8 = TemperatureYellow.9 = TemperatureRed.10 = VoltageYellow.11 = VoltageRed.12 = OnuManualPowerOff. 13 = InvImage.14 = PseOverloadYellow.15 = PseOverloadRed.",
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15
],
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Enum"
},
"OnuAlarmNotification": {
"properties": {
"alarm": {
"$ref": "#/components/schemas/OnuAlarmNotification.alarm"
"customerPremisesInfo": {
"description": "The physical location of the related customer sites.",
"items": {
"$ref": "#/components/schemas/CpInfo"
"type": "array",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "CpInfo"
"notificationType": {
"description": "Shall be set to \"OnuAlarmNotification\".",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
},
"onuId": {
"description": "The unique identifier for an optical network unit.",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
},
"timeStamp": {
"$ref": "#/components/schemas/TimeStamp"
}
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
"required": [
"notificationType",
"onuId",
"alarm"
],
"type": "object",
"x-etsi-ref": "6.4.2"
},
"OnuAlarmSubscription.alarms": {
"description": "In case alarms is not included in the subscription request, the default value -1 = All shall be used and included in the response:\n0 =\tEquipmentAlarm.\n\t(Functional failure on an internal interface.)\n1 =\tPoweringAlarm.\n\t(Loss of external power to battery backup unit. This alarm is typically derived through an external interface to a battery backup unit, and indicates that AC is no longer available to maintain battery charge.)\n2 =\tBatteryMissing.\n\t(Battery is provisioned but missing.)\n3 =\tBatteryFailure.\n\t(Battery is provisioned and present but cannot recharge.)\n4 =\tBatteryLow.\n\t(Battery is provisioned and present but its voltage is too low.)\n5 =\tPhysicalIntrusion.\n\t(Applies if the ONU supports detection such as door or box open.)\n6 =\tOnuSelfTestFailure.\n\t(ONU has failed autonomous self-test.)\n7 =\tDyingGasp.\n\t(ONU is powering off imminently due to loss of power to the ONU itself.)\n8 =\tTemperatureYellow.\n\t(No service shutdown at present, but the circuit pack is operating beyond its recommended range.)\n9 =\tTemperatureRed.\n\t(Some services have been shut down to avoid equipment damage.)\n10 =\tVoltageYellow.\n\t(No service shutdown at present, but the line power voltage is below its recommended minimum.)\n11 =\tVoltageRed.\n\t(Some services have been shut down to avoid power collapse.)\n12 =\tOnuManualPowerOff.\n\t(The ONU is shutting down because the subscriber has turned off its power switch.)\n13 =\tInvImage.\n\t(Software image is invalid.)\n14 =\tPseOverloadYellow.\n\t(Indicates that the ONU is nearing its maximum ability to supply the known PoE demand of the attached PDs. The thresholds for declaring and clearing this alarm are vendor-specific.)\n15 =\tPseOverloadRed.\n\t(Indicates that the ONU is unable to supply all of the PoE demand of the attached PDs and has removed or reduced power to at least one PD.)\n-1 =\tAll.",
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
-1
],
"type": "integer"
},
"OnuAlarmSubscription.links": {
"description": "Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests.",
"properties": {
"self": {
"$ref": "#/components/schemas/LinkType"
}
"required": [
"self"
],
"type": "object",
"x-etsi-mec-cardinality": "0..1"
},
"OnuAlarmSubscription.filterCriteriaOnuAlarm": {
"description": "List of filtering criteria for the subscription. Any filtering criteria from below, which is included in the request, shall also be included in the response.",
"properties": {
"alarms": {
"items": {
"$ref": "#/components/schemas/OnuAlarmSubscription.alarms"
},
"type": "array",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "Enum"
"customerPremisesInfo": {
"description": "0 to N physical locations of the customer sites.",
"items": {
"$ref": "#/components/schemas/CpInfo"
"type": "array",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "CpInfo"
"onuId": {
"description": "1 to N unique identifiers for the optical network units. Typical it is the unique serial number for each ONU, which contains the vendor ID and version number. The first four bytes are an ASCII-encoded four-letter vendor ID. The second four bytes are a binary encoded serial number, under the control of the ONU vendor.",
"items": {
"type": "string"
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
"minItems": 1,
"type": "array",
"x-etsi-mec-cardinality": "1..N",
"x-etsi-mec-origin-type": "String"
}
},
"required": [
"onuId"
],
"type": "object",
"x-etsi-mec-cardinality": "1"
},
"WebsockNotifConfig": {
"type": "object",
"properties": {
"subscriptionType": {
"description": "Set by FAIS to indicate to the service consumer the Websocket URI to be used for delivering notifications.",
"type": "uri"
},
"requestWebsocketUri": {
"description": "Set to true by the service consumer to indicate that Websocket delivery is requested.",
"type": "boolean"
}
}
},
"OnuAlarmSubscription": {
"properties": {
"_links": {
"$ref": "#/components/schemas/OnuAlarmSubscription.links"
},
"callbackReference": {
"description": "URI exposed by the client on which to receive notifications via HTTP. At least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to FAIS to choose an alternative and return only that alternative in the response, as described in ETSI GS MEC 009, clause 6.12a.",
"format": "uri",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "URI"
},
"requestTestNotification": {
"description": "Shall be set to TRUE by the service consumer to request",
"type": "boolean"
"websockNotifConfig": {
"description": "Provides details to negotiate and signal the use of a Websocket connection between FAIS and the service consumer for notifications. At least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to FAIS to choose an alternative and return only that alternative in the response, as described in ETSI GS MEC 009, clause 6.12a.",
"$ref": "#/components/schemas/WebsockNotifConfig"
},
"expiryDeadline": {
"$ref": "#/components/schemas/TimeStamp"
},
"filterCriteriaOnuAlarm": {
"$ref": "#/components/schemas/OnuAlarmSubscription.filterCriteriaOnuAlarm"
},
"subscriptionType": {
"description": "Shall be set to \\\"OnuAlarmSubscription\\\".",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
}
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
"required": [
"subscriptionType",
"filterCriteriaOnuAlarm"
],
"type": "object",
"x-etsi-ref": "6.3.2"
},
"PonInfo.opticalNetworkInfo.dsRate": {
"description": "Downstream line rate, valid values are:\n1 =\t2,48832 Gbit/s: G-PON [i.9]; or\nNG-PON2 option 2 [i.8].\n2 =\t9,95328 Gbit/s: XG-PON [i.10]; or\n XGS-PON [i.11]; or\nNG-PON2 option 1 [i.8].",
"enum": [
1,
2
],
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Enum"
},
"PonInfo.opticalNetworkInfo.operationalState": {
"description": "It reports whether the ONU is currently capable of performing its function. Valid values are: 0 = enabled 1 = disabled",
"enum": [
0,
1
],
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Enum"
},
"PonInfo.opticalNetworkInfo.ponTech": {
"description": "An informative field identifying the optical technology used. The valid values are: 1 = GPON. 2 = XGPON.3 = NGPON2. 4 = XGSPON.",
"enum": [
1,
2,
3,
4
],
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Enum"
},
"PonInfo.opticalNetworkInfo.usRate": {
"description": "Upstream line rate, valid values are:\n1 =\t1,24416 Gbit/s: G-PON option 1 [i.9].\n2 =\t2,48832 Gbit/s: G-PON option 2 [i.9]; or\nXG-PON [i.10]; or\nNG-PON2 option 2 [i.8].\n3 =\t9,95328 Gbit/s: XGS-PON [i.11]; or\nNG-PON2 option 1 [i.8].",
"enum": [
1,
2,
3
],
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Enum"
},
"PonInfo": {
"properties": {
"timeStamp": {
"$ref": "#/components/schemas/TimeStamp"
},
"customerPremisesInfo": {
"description": "The physical location of a customer site.",
"$ref": "#/components/schemas/CpInfo",
"minItems": 1,
"type": "array",
"x-etsi-mec-cardinality": "1..N",
"x-etsi-mec-origin-type": "CpInfo"
},
"ponSYS_ID": {
"description": "The 20-bit identity of the optical system within a certain domain.This is a reference value set by the OSS.",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
},
"onuId": {
"description": "Information to identify an Optical Network Unit.",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
},
"ponTech": {
"$ref": "#/components/schemas/PonInfo.opticalNetworkInfo.ponTech"
},
"operationalState": {
"$ref": "#/components/schemas/PonInfo.opticalNetworkInfo.operationalState"
},
"dsRate": {
"$ref": "#/components/schemas/PonInfo.opticalNetworkInfo.dsRate"
},
"usRate": {
"$ref": "#/components/schemas/PonInfo.opticalNetworkInfo.usRate"
}
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
"required": [
"customerPremisesInfo",
"ponSYS_ID",
"opticalNetworkInfo",
"onuId",
"ponTech",
"operationalState",
"dsRate",
"usRate"
],
"type": "object",
"x-etsi-ref": "6.2.5"
},
"SubscriptionLinkList.links.subscription.subscriptionType": {
"description": "Type of the subscription. The string shall be set according to the \"subscriptionType\" attribute of the associated subscription data type defined in clauses 6.3.2, 6.3.3, 6.3.4 and 6.3.6 \"OnuAlarmSubscription\" \"DevInfoSubscription\" \"CmConnSubscription\" \"AniAlarmSubscription\"",
"enum": [
"OnuAlarmSubscription",
"DevInfoSubscription",
"CmConnSubscription",
"AniAlarmSubscription\""
],
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Enum"
},
"SubscriptionLinkList.links.subscription": {
"properties": {
"href": {
"description": "The URI referring to the subscription.",
"format": "uri",
"type": "uri",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "URI"
"subscriptionType": {
"$ref": "#/components/schemas/SubscriptionLinkList.links.subscription.subscriptionType"
}
"required": [
"href",
"subscriptionType"
]
},
"SubscriptionLinkList.links": {
"description": "Hyperlinks related to the resource.",
"type": "object",
"required": [
"self"
],
"properties": {
"self": {
"$ref": "#/components/schemas/LinkType"
},
"subscriptions": {
"description": "The service consumer's subscriptions.",
"type": "array",
"items": {
"$ref": "#/components/schemas/SubscriptionLinkList.links.subscription"
}
},
"SubscriptionLinkList": {
"properties": {
"_links": {
"$ref": "#/components/schemas/SubscriptionLinkList.links"
}
"required": [
"_links"
],
"type": "object",
"x-etsi-ref": "6.3.5"
},
"TestNotification": {
"type": "object",
"required": [
"notificationType",
"_links"
],
"properties": {
"notificationType": {
"description": "Shall be set to \"TestNotification",
"type": "string"
"_links": {
"description": "Hyperlink related to the resource.",
"type": "object",
"required": [
"subscription"
],
"properties": {
"subscription": {
"$ref": "#/components/schemas/LinkType"
}
}
}
},
"TimeStamp": {
"properties": {
"nanoSeconds": {
"description": "The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.",
"format": "Uint32",
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uint32"
"seconds": {
"description": "The seconds part of the time. Time is defined as Unixtime since January 1, 1970, 00:00:00 UTC.",
"format": "Uint32",
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uint32"
}
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
"required": [
"seconds",
"nanoSeconds"
],
"type": "object",
"x-etsi-ref": "6.5.2"
},
"TraceRouteDiagnostics.diagnosticsState": {
"description": "The state of the IP trace-route test. Enumeration of: 1 = None. 2 = Requested. 3 = Complete. 4 = Error_CannotResolveHostName. 5 = Error_MaxHopCountExceeded. 6 = Error_Internal. 7 = Error_Other.",
"enum": [
1,
2,
3,
4,
5,
6,
7
],
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Enum"
},
"TraceRouteDiagnostics": {
"properties": {
"dataBlockSize": {
"description": "Size of the data block in bytes to be sent for each trace route.",
"type": "integer",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Integer"
"diagnosticsState": {
"$ref": "#/components/schemas/TraceRouteDiagnostics.diagnosticsState"
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
"host": {
"description": "Host name or address of the host to find a route to.",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
},
"maxHopCount": {
"description": "The maximum number of hop used in outgoing probe packets. The default is 30 hops.",
"type": "integer",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Integer"
},
"numberOfRouteHops": {
"description": "Result parameter indicating the number of hops within the discovered route.\n\nIf a route could not be determined, this value shall be zero.",
"type": "integer",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Integer"
},
"responseTime": {
"description": "Result parameter indicating the response time in milliseconds the most recent trace route test.\n\nIf a route could not be determined, this value shall be zero.",
"type": "integer",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Integer"
},
"timeout": {
"description": "Timeout in milliseconds for the trace route test.",
"type": "integer",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Integer"
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
"required": [
"diagnosticsState"
],
"type": "object",
"x-etsi-ref": "6.5.5"
},
"UploadDiagnostics.diagnosticsState": {
"description": "The state of the HTTP and FTP download test. Enumeration of: 1 = None. 2 = Requested. 3 = Completed. 4 = Error_InitConnectionFailed. 5 = Error_NoResponse. 6 = Error_PasswordRequestFailed. 7 = Error_LoginFailed. 8 = Error_NoTransferMode. 9 = Error_NoPASV. 10 = Error_NoCWD. 11 = Error_NoSTOR.12 = Error_NoTransferComplete.",
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12
],
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Enum"
},
"UploadDiagnostics": {
"properties": {
"bOMTime": {
"$ref": "#/components/schemas/TimeStamp"
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
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
"diagnosticsState": {
"$ref": "#/components/schemas/UploadDiagnostics.diagnosticsState"
},
"eOMTime": {
"$ref": "#/components/schemas/TimeStamp"
},
"rOMTime": {
"$ref": "#/components/schemas/TimeStamp"
},
"tCPOpenReponseTime": {
"$ref": "#/components/schemas/TimeStamp"
},
"tCPOpenRequestTime": {
"$ref": "#/components/schemas/TimeStamp"
},
"testBytesSent": {
"description": "The test traffic sent in bytes during the FTP/HTTP transaction including FTP/HTTP headers, between bOMTime and eOMTime.",
"type": "integer",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Integer"
},
"testFileLength": {
"description": "The size of the file (in bytes) to be uploaded to the\nserver.",
"type": "integer",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Integer"
},
"uploadURI": {
"description": "The URI for the device to perform the upload to.",
"format": "uri",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "URI"
}
},
"required": [
"diagnosticsState"
],
"type": "object",
"x-etsi-ref": "6.5.7"
},
"LinkType": {
"description": "'URI referring to a resource'",
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"$ref": "#/components/schemas/Href"
}
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
"Href": {
"description": "The URI referring to the subscription.",
"type": "string",
"format": "uri"
},
"ProblemDetails": {
"properties": {
"detail": {
"description": "A human-readable explanation specific to this occurrence of the problem",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
},
"instance": {
"description": "A URI reference that identifies the specific occurrence of the problem",
"format": "uri",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "URI"
},
"status": {
"description": "The HTTP status code for this occurrence of the problem",
"format": "uint32",
"type": "integer",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Uint32"
},
"title": {
"description": "A short, human-readable summary of the problem type",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
},
"type": {
"description": "A URI reference according to IETF RFC 3986 that identifies the problem type",
"format": "uri",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "URI"
}
"type": "object"
}
},
"responses": {
"204": {
"description": "No Content"
},
"206": {
"description": "Partial content"
},
"400": {
"description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"401": {
"description": "Unauthorized : used when the client did not submit credentials.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"403": {
"description": "Forbidden : operation is not allowed given the current status of the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"404": {
"description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"406": {
"description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"409": {
"description": "Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"412": {
"description": "Precondition failed : used when a condition has failed during conditional requests, e.g. when using ETags to avoid write conflicts when using PUT",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"415": {
"description": "Unsupported Media Type : used to indicate that the server or the client does not support the content type of the entity body.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"422": {
"description": "Unprocessable Entity : used to indicate that the server understands the content type of the request entity and that the syntax of the request entity is correct but that the server is unable to process the contained instructions. This error condition can occur if an JSON request body is syntactically correct but semantically incorrect, for example if the target area for the request is considered too large. This error condition can also occur if the capabilities required by the request are not supported.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"429": {
"description": "Too Many Requests : used when a rate limiter has triggered.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"