"description":"A response body containing the device information is returned",
"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"
@@ -258,7 +261,7 @@
],
"responses":{
"200":{
"description":"A response body containing the cable line information is returned.",
"description":"Upon success, a response body containing the information of zero or more cable lines is returned.",
"content":{
"application/json":{
"schema":{
@@ -336,7 +339,7 @@
],
"responses":{
"200":{
"description":"A response body containing the optical network information is returned.",
"description":"Upon success, a response body containing the information of zero or more optical networks is returned",
"content":{
"application/json":{
"schema":{
@@ -385,7 +388,7 @@
"type":"string"
},
"required":false,
"description":"Query parameter to filter on a specific subscription type. Permitted values: ONU_ALARM. DEVICE_ABNORMAL_ALERT. CM_CONNECTIVITY_STATE. ANI_ALARM."
"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":{
@@ -760,7 +763,6 @@
"items":{
"$ref":"#/components/schemas/CpInfo"
},
"minItems":0,
"type":"array",
"x-etsi-mec-cardinality":"0..N",
"x-etsi-mec-origin-type":"CpInfo"
@@ -823,7 +825,6 @@
"aniId"
],
"description":"0 to N physical locations of the customer sites.",
"minItems":0,
"type":"array",
"items":{
"$ref":"#/components/schemas/CpInfo"
@@ -882,12 +883,20 @@
"x-etsi-mec-origin-type":"String"
},
"callbackReference":{
"description":"URI selected by the service consumer to receive notifications on the subscribed FAIS information. This shall be included both in the request and in response.",
"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"
},
@@ -905,83 +914,26 @@
"type":"object",
"x-etsi-ref":"6.3.6"
},
"CableLineInfo.cmInfo.serviceFlowStats":{
"description":"It describes statistics associated with the Service Flows in a managed device.",
"properties":{
"ifIndex":{
"description":"It represents the interface index of the MAC Domain of the Service Flow",
"description":"It represents the information of a Service Flow.",
"cmRegState",
"resets",
"lostSyncs",
"invalidRegRsps",
"energyMgt1x1OperStatus",
"emDlsOperStatus"
],
"properties":{
"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",
"x-etsi-mec-cardinality":"1",
"x-etsi-mec-origin-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",
"x-etsi-mec-cardinality":"1",
"x-etsi-mec-origin-type":"Integer"
},
"policedDelayPkts":{
"description":"It counts only outgoing packets delayed in order to maintain the Maximum Sustained Traffic Rate.",
"type":"integer",
"x-etsi-mec-cardinality":"1",
"x-etsi-mec-origin-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:\n1)\texceeding the selected Buffer Size for the service flow; or\n2)\tUGS packets dropped due to exceeding the Unsolicited Grant Size with a Request/Transmission policy that requires such packets to be dropped.",
"type":"integer",
"x-etsi-mec-cardinality":"1",
"x-etsi-mec-origin-type":"Integer"
},
"serviceFlowId":{
"description":"It represents an identifier assigned to a Service Flow by CMTS within a MAC Domain.",
"type":"integer",
"x-etsi-mec-cardinality":"1",
"x-etsi-mec-origin-type":"Integer"
"ifIndex":{
"description":"It denotes the MAC Domain interface index of the CM.",
"type":"string"
},
"timeActive":{
"description":"It indicates the number of seconds that the service flow has been active.",
"description":"It represents an identifier assigned to a Service Flow by CMTS within a MAC Domain.",
"type":"integer"
},
"cmId":{
"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 thedevice, including across firmware updates.",
"type":"string",
"x-etsi-mec-cardinality":"1",
"x-etsi-mec-origin-type":"String"
"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.",
"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"
},
"serviceFlowStats":{
"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.",
"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."
"description":"URI selected by the service consumer to receive notifications on the subscribed FAIS information. This shall be included both in the request and in response.",
"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"
},
@@ -1376,7 +1330,6 @@
},
"required":[
"subscriptionType",
"callbackReference",
"filterCriteriaCmConn"
],
"type":"object",
@@ -1386,14 +1339,14 @@
"CpInfo":{
"properties":{
"latitude":{
"description":"Latitude (DATUM=WGS84)\n-90 to 90 in decimal degree format DDD.ddd",
"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)\n-180 to 180 in decimal degree format DDD.ddd",
"description":"Longitude (DATUM=WGS84)-180 to 180 in decimal degree format DDD.ddd",
"description":"URI selected by the service consumer to receive notifications on the subscribed FAIS information. This shall be included both in the request and in response.",
"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"
},
@@ -1544,10 +1502,7 @@
"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":"array",
"items":{
"type":"string"
},
"type":"string",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"String"
},
@@ -1558,7 +1513,7 @@
"$ref":"#/components/schemas/DownloadDiagnostics"
},
"gwId":{
"description":"Information (typically the serial number) to identify an Internet Gateway Device through which\nthe customer premises device is connected.\n\nThis value shall remain fixed over the lifetime of the device, including across firmware updates.",
"description":"Information (typically the serial number) to identify an Internet Gateway Device through whichthe customer premises device is connected.This value shall remain fixed over the lifetime of the device, including across firmware updates.",
"items":{
"type":"string"
},
@@ -1618,6 +1573,7 @@
},
"required":[
"gwId",
"deviceId",
"deviceStatus",
"upTime",
"iPConnectionUpTime",
@@ -1660,7 +1616,7 @@
"downloadURI":{
"description":"The URI for the device to perform the download on.",
"format":"uri",
"type":"string",
"type":"uri",
"x-etsi-mec-cardinality":"0..1",
"x-etsi-mec-origin-type":"URI"
},
@@ -1701,7 +1657,7 @@
"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.",
"description":"1 to N unique identifiers for the optical network units.\nTypical 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.",
"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"
},
@@ -2044,18 +1997,39 @@
"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.",
"description":"URI selected by the service consumer to receive notifications on the subscribed FAIS information. This shall be included both in the request and in response.",
"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"
},
@@ -2071,7 +2045,6 @@
},
"required":[
"subscriptionType",
"callbackReference",
"filterCriteriaOnuAlarm"
],
"type":"object",
@@ -2120,15 +2093,24 @@
"x-etsi-mec-cardinality":"1",
"x-etsi-mec-origin-type":"Enum"
},
"PonInfo.opticalNetworkInfo":{
"description":"",
"items":{
"type":"object"
"PonInfo":{
"properties":{
"timeStamp":{
"$ref":"#/components/schemas/TimeStamp"
},
"customerPremisesInfo":{
"description":"The physical location of a customer site.",
"description":"Numeric value (0 - 255) corresponding to specified type of subscription as following: 0 = RESERVED. 1 = ONU_ALARM. 2 = DEVICE_ABNORMAL_ALERT. 3 = CM_CONNECTIVITY_STATE.4 = ANI_ALARM.",
"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":[
0,
1,
2,
3,
4
"OnuAlarmSubscription",
"DevInfoSubscription",
"CmConnSubscription",
"AniAlarmSubscription\""
],
"type":"integer",
"type":"string",
"x-etsi-mec-cardinality":"1",
"x-etsi-mec-origin-type":"Enum"
},
"SubscriptionLinkList.links.subscription":{
"description":"A link to a subscription.",
"properties":{
"href":{
"description":"The URI referring to the subscription.",
"format":"uri",
"type":"string",
"type":"uri",
"x-etsi-mec-cardinality":"1",
"x-etsi-mec-origin-type":"URI"
},
@@ -2223,9 +2175,17 @@
]
},
"SubscriptionLinkList.links":{
"description":"List of hyperlinks related to the resource.",
"description":"Hyperlinks related to the resource.",
"type":"object",
"required":[
"self"
],
"properties":{
"subscription":{
"self":{
"$ref":"#/components/schemas/LinkType"
},
"subscriptions":{
"description":"The service consumer's subscriptions.",
*[Navigate the Fixed Access Information API in the browser](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/rep/mec/gs029-fai-api/raw/stf606-final/MEC029_FAI.yaml)
*[Edit the Fixed Access Information API online ](https://forge.etsi.org/swagger/editor/?url=https://forge.etsi.org/rep/mec/gs029-fai-api/raw/stf606-final/MEC029_FAI.yaml)