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"
$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:
summary:Retrieve a list of active subscriptions for this subscriber.
description:The GET method is used to request information about the subscriptions for this requestor. Upon success, the response contains entity body with the list of links to the subscriptions that are present for the requestor.
description:Upon success, a response body containing the list of links to requestor's subscriptions is returned. The list shall only contain subscriptions of the subscription type specified by the URI query parameters.
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"
type:object
properties:
SubscriptionLinkList:
$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:
summary:Create a new subscription.
description:The POST method is used to create a new subscription to FAI notifications. Upon success, the response contains entity body describing the created subscription.
summary:Retrieve information on current specific subscription.
description:The GET method is used to retrieve information about this subscription. Upon success, the response contains entity body with the data type describing the subscription.
description:The unique identifier of the subscriptionId.
schema:
type:string
put:
summary:Modify existing subscription by sending a new data structure.
description:The PUT method is used to update the existing subscription. PUT method in this case has "replace" semantics. Upon successful operation, the target resource is updated with new Data Type received within the message body of the PUT request.
description:The unique identifier of the subscriptionId.
schema:
oneOf:
-$ref:"#/components/schemas/OnuAlarmSubscription"
-$ref:"#/components/schemas/DevInfoSubscription"
-$ref:"#/components/schemas/CmConnSubscription"
-$ref:"#/components/schemas/AniAlarmSubscription"
"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"
type:string
delete:
summary:Cancel the existing subscription.
description:The DELETE method is used to cancel the existing subscription. Cancellation can be made by deleting the resource that represents existing subscription.
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.
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.
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
timeStamp:
description:Time stamp.
$ref:'#/components/schemas/TimeStamp'
customerPremisesInfo:
description:The physical location of a customer site.
description:Information to identify an Optical Network Unit.
type:string
ponTech:
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.
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.
description:Provides details to negotiate and signal the use of a Websocket connection between FAIS and the service consumer for notifications. See note.
description:Provides details to negotiate and signal the use of a Websocket connection between FAIS and the service consumer for notifications. See note.
description:Provides details to negotiate and signal the use of a Websocket connection between FAIS and the service consumer for notifications. See note 1.
description:Provides details to negotiate and signal the use of a Websocket connection between FAIS and the service consumer for notifications. See note.
description:Shall be set to "OnuAlarmNotification".
type:string
timeStamp:
# description': Time stamp.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': TimeStamp
$ref:"#/components/schemas/TimeStamp"
description:Time stamp.
$ref:'#/components/schemas/TimeStamp'
customerPremisesInfo:
# description': The physical location of a customer site.
# x-etsi-mec-cardinality': '1'
# x-etsi-mec-origin-type': CpInfo
$ref:"#/components/schemas/CpInfo"
cmId:
description:The physical location of the related customer sites.
type:array
minItems:0
items:
$ref:'#/components/schemas/CpInfo'
onuId:
description:The unique identifier for an optical network unit.
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.
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.
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.
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.
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.
description:The URI for the device to perform the download on.
format:uri
type:string
x-etsi-mec-cardinality:0..1
x-etsi-mec-origin-type:URI
eOMTime:
# description': End of transmission in UTC, which shall be specified to microsecond precision.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': TimeStamp
$ref:"#/components/schemas/TimeStamp"
format:uri
rOMTime:
# description': Request time in UTC, which shall be specified to microsecond precision.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': TimeStamp
$ref:"#/components/schemas/TimeStamp"
tCPOpenReponseTime:
# description': Response time in UTC, which shall be specified to microsecond precision.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': TimeStamp
$ref:"#/components/schemas/TimeStamp"
tCPOpenRequestTime:
# description': Request time in UTC, which shall be specified to microsecond precision.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': TimeStamp
$ref:"#/components/schemas/TimeStamp"
description:Request time in UTC, which shall be specified to microsecond precision.
$ref:'#/components/schemas/TimeStamp'
bOMTime:
description:Begin of transmission time in UTC, which shall be specified to microsecond precision.
$ref:'#/components/schemas/TimeStamp'
eOMTime:
description:End of transmission in UTC, which shall be specified to microsecond precision.
$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
tCPOpenRequestTime:
description:Request time in UTC, which shall be specified to microsecond precision.
$ref:'#/components/schemas/TimeStamp'
tCPOpenReponseTime:
description:Response time in UTC, which shall be specified to microsecond precision.
$ref:'#/components/schemas/TimeStamp'
required:
-diagnosticsState
UploadDiagnostics:
x-etsi-ref:6.5.7
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.
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:It indicates the time when the service flow was created.
$ref:'#/components/schemas/TimeStamp'
timeActive:
description:It indicates the number of seconds that the service flow has been active.
description:It counts only outgoing packets delayed in order to maintain the Maximum Sustained Traffic Rate.
type:integer
OnuAlarmSubscription.links:
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
required:
-serviceFlowId
-pkts
-timeCreated
-timeActive
-policedDropPkts
-policedDelayPkts
-aqmDroppedPkts
ServiceFlowStats:
description:It describes statistics associated with the Service Flows in a managed device.
type:object
properties:
ifIndex:
description:It represents the interface index of the MAC Domain of the Service Flow.
type:string
serviceFlowInfo:
type:array
items:
$ref:'#/components/schemas/ServiceFlowInfo'
required:
-ifIndex
-serviceFlowInfo
_links:
description:Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests.
type:object
properties:
self:
# description': Self referring URI. The URI shall be unique within the FAI API as it acts as an ID for the subscription.
# x-etsi-mec-cardinality': '1'
# x-etsi-mec-origin-type': LinkType
$ref:"#/components/schemas/LinkType"
description:Self-referring URI. The URI shall be unique within the FAI API as it acts as an ID for the subscription.
$ref:'#/components/schemas/LinkType'
required:
-self
type:object
x-etsi-mec-cardinality:0..1
OnuAlarmSubscription.filterCriteriaOnuAlarm:
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.
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.
type:object
x-etsi-mec-cardinality:"1"
properties:
gwId:
description:The identifier of an Internet Gateway Device through which the customer premises device is connected.
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
ifIndex:
description:The MAC Domain interface index of the CM.
type:array
minItems:1
items:
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.
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.
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:
items:
$ref:'#/components/schemas/CmIf'
Subscriptions:
description:The service consumer's subscriptions.
type:object
properties:
href:
description:The URI referring to the subscription.
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.
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.
description:List of hyperlinks related to the resource.
type:object
required:
-href
properties:
href:
$ref:"#/components/schemas/Href"
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
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.
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
required:
-self
_links3:
description:'Hyperlinkrelatedtotheresource.'
type:object
properties:
subscription:
description:URI identifying the subscription for the test notification.