Newer
Older
"title": "OBssLoad",
"required": [
"allocatedTrafficSelfMean",
"allocatedTrafficShareMean"
],
"type": "object",
"properties": {
"allocatedTrafficSelfMean": {
"type": "integer",
"description": "Mean of allocated traffic from this AP (BSS) in units of 32 µs per second.",
},
"allocatedTrafficSelfStdDev": {
"type": "integer",
"description": "Standard deviation from the mean of allocation traffic from this BSS in units of 32 µs per second.",
"contentEncoding": "int32"
},
"allocatedTrafficShareMean": {
"type": "integer",
"description": "Mean of the sum of allocated traffic from other APs on the overlapping channel in unit of 32 µs per second.",
"contentEncoding": "int32"
},
"allocatedTrafficShareStdDev": {
"type": "integer",
"description": "Standard deviation from the mean of the sum of allocated traffic from other APs on the overlapping channel in unit of 32 µs per second.",
"contentEncoding": "int32"
"description": "Indicates the number of other APs that are sharing the same channel as the reporting AP.",
"contentEncoding": "int32"
"title": "ProblemDetails",
"type": "object",
"description": "A human-readable explanation specific to this occurrence of the problem"
"description": "A URI reference that identifies the specific occurrence of the problem"
"description": "The HTTP status code for this occurrence of the problem",
"contentEncoding": "int32"
"description": "A short, human-readable summary of the problem type"
"description": "A URI reference according to IETF RFC 3986 that identifies the problem type"
"title": "ReportedBeaconFrameInfo",
"required": [
"frameType",
"phyType"
],
"type": "object",
"description": "A value of 0 indicates a Beacon or Probe Response.\nA value of 1 indicates a Measurement Pilot frame.",
"contentEncoding": "int32"
"description": "Value between 0 and 127 coded according to dot11PHYType.",
"contentEncoding": "int32"
}
},
"ReportingReasonQoSCounters": {
"title": "ReportingReasonQoSCounters",
"qosAckFailure",
"qosDiscarded",
"qosFailed",
"qosFrameDuplicate",
"qosMultipleRetry",
"qosRetry",
"qosRtsFailure"
],
"type": "object",
"properties": {
"qosAckFailure": {
"type": "boolean",
}
},
"ReportingReasonStaCounters": {
"title": "ReportingReasonStaCounters",
"ackFailure",
"failed",
"fcsError",
"frameDuplicate",
"multipleRetry",
"retry",
"rtsFailure"
],
"type": "object",
"properties": {
"ackFailure": {
"type": "boolean",
}
},
"Rssi": {
"title": "Rssi",
"properties": {
"rssi": {
"type": "integer",
"description": "The Received Signal Strength Indicator from a station",
"contentEncoding": "int32"
"title": "STACounterTriggerCondition",
"type": "object",
"properties": {
"ackFailureCountThreshold": {
"type": "integer",
"description": "Configure and set threshold for dot11AckFailureCount trigger",
"contentEncoding": "int32"
"description": "Configure and set threshold for dot11FailedCount trigger",
"contentEncoding": "int32"
"description": "Configure and set threshold for dot11FCSErrorCount trigger",
"contentEncoding": "int32"
},
"frameDuplicateCountThreshold": {
"type": "integer",
"description": "Configure and set threshold for dot11FrameDuplicateCount trigger",
"contentEncoding": "int32"
},
"multipleRetryCountThreshold": {
"type": "integer",
"description": "Configure and set threshold for dot11MultipleRetryCount trigger",
"contentEncoding": "int32"
"description": "Configure and set threshold for dot11RetryCount trigger",
"contentEncoding": "int32"
},
"rtsFailureCountThreshold": {
"type": "integer",
"description": "Configure and set threshold for dot11RTSFailureCount trigger",
"contentEncoding": "int32"
"title": "StaDataRate",
"type": "object",
},
"staLastDataDownlinkRate": {
"type": "integer",
"description": "The data transmit rate in kbps that was most recently used for transmission of data PPDUs from the access point to the station.",
"contentEncoding": "int32"
},
"staLastDataUplinkRate": {
"type": "integer",
"description": "The data transmit rate in Kbps that was most recently used for transmission of data PPDUs from the associated station to the access point.",
"contentEncoding": "int32"
"title": "StaDataRateNotification",
"allOf": [
{
"$ref": "#/components/schemas/InlineNotification"
{
"type": "object",
"properties": {
"staDataRate": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StaDataRate"
},
"description": "Data rates of a client station."
},
"timeStamp": {
"$ref": "#/components/schemas/TimeStamp"
}
}
"title": "StaDataRateSubscription",
"allOf": [
{
"$ref": "#/components/schemas/InlineSubscription"
},
{
"_links": {
"$ref": "#/components/schemas/Links"
"type": "string",
"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 WAIS to select an alternative and return only that alternative in the response, as specified in ETSI GS MEC 009, clause 6.12a."
},
"expiryDeadline": {
"$ref": "#/components/schemas/TimeStamp"
"notificationEvent": {
"$ref": "#/components/schemas/NotificationEvent1"
},
"notificationPeriod": {
"description": "Set for periodic notification reporting.Value indicates the notification period in seconds.",
"contentEncoding": "int32"
},
"requestTestNotification": {
"type": "boolean",
"description": "Set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, as specified in ETSI GS MEC 009, clause 6.12a."
},
"staId": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StaIdentity"
},
"description": "Identifier(s) to uniquely specify the target client station(s) for the subscription."
},
"websockNotifConfig": {
"$ref": "#/components/schemas/WebsockNotifConfig",
"description": "Provides details to negotiate and signal the use of a Websocket connection between the WAIS 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 WAIS to select an alternative and return only that alternative in the response, as specified in ETSI GS MEC 009, clause 6.12a"
]
},
"StaIdentity": {
"title": "StaIdentity",
],
"type": "object",
"properties": {
"aid": {
"type": "string",
"description": "Number which identifies a particular association between a station and an Access Point"
"description": "IPv4 or IPv6 address(es) allocated for the station."
"description": "Unique identifier assigned to station (as network interface controller) for communications at the data link layer of a network segment."
"description": "Service Set Identifier(s) to identify logical networks."
}
},
"StaInfo": {
"title": "StaInfo",
],
"type": "object",
"properties": {
"apAssociated": {
"items": {
"$ref": "#/components/schemas/BeaconReport"
},
"description": "Beacon Report as defined in IEEE 802.11-2016."
"description": "Channel currently used by the station to connect with its associated Access Point.",
"contentEncoding": "int32"
"items": {
"$ref": "#/components/schemas/ChannelLoad"
},
"description": "Channel Load reports as seen by the station as defined IEEE 802.11-2016. Channel Load reports may be configured for any channel, including the station's current channel for association."
"items": {
"$ref": "#/components/schemas/NeighborReport"
},
"description": "Information about neighbor Access Points seen by the station as defined IEEE 802.11-2016."
"items": {
"$ref": "#/components/schemas/StaStatistics"
},
"description": "Statistics as defined in IEEE 802.11-2016 for the client station collected over measurement duration."
}
},
"StaStatistics": {
"title": "StaStatistics",
"groupIdentity",
"measurementDuration",
"measurementId"
],
"type": "object",
"properties": {
"group2to9Data": {
"$ref": "#/components/schemas/StaStatisticsGroup2to9Data"
"description": "Indicates the requested statistics group describing the Statistics Group Data according to Table 9-114 of IEEE 802.11-2016.\nDepending on group identity, one and only one of the STA Statistics Group Data will be present.",
"groupOneData": {
"$ref": "#/components/schemas/StaStatisticsGroupOneData"
"groupZeroData": {
"$ref": "#/components/schemas/StaStatisticsGroupZeroData"
"description": "Duration over which the Statistics Group Data was measured in time units of 1 024 µs. Duration equal to zero indicates a report of current values.",
"contentEncoding": "int32"
"description": "Measurement ID of the Measurement configuration applied to this STA Statistics Report."
"staId": {
"$ref": "#/components/schemas/StaIdentity"
}
}
},
"StaStatisticsConfig": {
"title": "StaStatisticsConfig",
],
"type": "object",
"properties": {
"groupIdentity": {
"description": "As per Table 9-92 of IEEE 802.11-2016.",
"description": "Valid if triggeredReport = true.\nSpecifies the number of MAC service data units or protocol data units to determine if the trigger conditions are met.",
"contentEncoding": "int32"
"triggerCondition": {
"$ref": "#/components/schemas/STACounterTriggerCondition"
"description": "Valid if triggeredReport = true.\nThe Trigger Timeout field contains a value in units of 100 time-units of 1 024 µs during which a measuring STA does not generate further triggered STA Statistics Reports after a trigger condition has been met.",
"contentEncoding": "int32"
"description": "True = triggered reporting, otherwise duration."
}
},
"StaStatisticsGroup2to9Data": {
"title": "StaStatisticsGroup2to9Data",
"qosAckFailureCount",
"qosDiscardedFrameCount",
"qosFailedCount",
"qosFrameDuplicateCount",
"qosMPDUsReceivedCount",
"qosMultipleRetryCount",
"qosRTSFailureCount",
"qosRTSSuccessCount",
"qosReceivedFragmentCount",
"qosRetriesReceivedCount",
"qosRetryCount",
"qosTransmittedFragmentCount",
"qosTransmittedFrameCount"
],
"type": "object",
"properties": {
"qosAckFailureCount": {
"description": "dot11QosAckFailureCount counter",
"contentEncoding": "int32"
"description": "dot11QosDiscardedFrameCount counter",
"contentEncoding": "int32"
"description": "dot11QosFailedCount counter",
"contentEncoding": "int32"
"description": "dot11QosFrameDuplicateCount counter",
"contentEncoding": "int32"
"description": "dot11QosMPDUsReceivedCount counter",
"contentEncoding": "int32"
"description": "dot11QosMultipleRetryCount counter",
"contentEncoding": "int32"
"description": "dot11QosRTSFailureCount counter",
"contentEncoding": "int32"
"description": "dot11QosRTSSuccessCount counter",
"contentEncoding": "int32"
"description": "dot11QosReceivedFragmentCount counter",
"contentEncoding": "int32"
"description": "dot11QosRetriesReceivedCount counter",
"contentEncoding": "int32"
"description": "dot11QosRetryCount counter",
"contentEncoding": "int32"
"description": "dot11QosTransmittedFragmentCount counter",
"contentEncoding": "int32"
"description": "dot11QosTransmittedFrameCount counter",
"contentEncoding": "int32"
"reportingReasonQoSCounters": {
"$ref": "#/components/schemas/ReportingReasonQoSCounters"
}
}
},
"StaStatisticsGroupOneData": {
"title": "StaStatisticsGroupOneData",
"ackFailureCount",
"frameDuplicateCount",
"multipleRetryCount",
"retryCount",
"rtsFailureCount",
"rtsSuccessCount"
],
"type": "object",
"properties": {
"ackFailureCount": {
"description": "dot11AckFailureCount counter",
"contentEncoding": "int32"
"description": "dot11FrameDuplicateCount counter",
"contentEncoding": "int32"
"description": "dot11MultipleRetryCount counter",
"contentEncoding": "int32"
"reportingReasonStaCounters": {
"$ref": "#/components/schemas/ReportingReasonStaCounters"
"description": "dot11RetryCount counter",
"contentEncoding": "int32"
"description": "dot11RTSFailureCount counter",
"contentEncoding": "int32"
"description": "dot11RTSSuccessCount counter",
"contentEncoding": "int32"
}
},
"StaStatisticsGroupZeroData": {
"title": "StaStatisticsGroupZeroData",
"failedCount",
"fcsErrorCount",
"groupReceivedFrameCount",
"groupTransmittedFrameCount",
"receivedFragmentCount",
"transmittedFragmentCount",
"transmittedFrameCount"
],
"type": "object",
"properties": {
"failedCount": {
"description": "dot11FailedCount counter",
"contentEncoding": "int32"
"description": "dot11FCSErrorCount counter",
"contentEncoding": "int32"
"description": "dot11GroupReceivedFrameCount counter",
"contentEncoding": "int32"
"description": "dot11GroupTransmittedFrameCount counter",
"contentEncoding": "int32"
"description": "dot11ReceivedFragmentCount counter",
"contentEncoding": "int32"
"reportingReasonStaCounters": {
"$ref": "#/components/schemas/ReportingReasonStaCounters"
"description": "dot11TransmittedFragmentCount counter",
"contentEncoding": "int32"
"description": "dot11TransmittedFrameCount counter",
"contentEncoding": "int32"
}
},
"SubscriptionLinkList": {
"title": "SubscriptionLinkList",
"$ref": "#/components/schemas/Subscription"
}
},
"TestNotification": {
"title": "TestNotification",
],
"type": "object",
"properties": {
"_links": {
"description": "Shall be set to \"TestNotification\"."
}
},
"TimeStamp": {
"title": "TimeStamp",
"description": "The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.",
"contentEncoding": "int32"
"description": "The seconds part of the time. Time is defined as Unixtime since January 1, 1970, 00:00:00 UTC.",
"contentEncoding": "int32"
}
},
"VhtCapabilities": {
"title": "VhtCapabilities",
],
"type": "object",
"properties": {
"vhtCapInfo": {
"description": "VHT capabilities Info as defined in IEEE 802.11-2016.",
"description": "Supported VHT-MCS and NSS Set as defined in IEEE 802.11-2016.",
}
},
"WanMetrics": {
"title": "WanMetrics",
"downlinkLoad",
"downlinkSpeed",
"lmd",
"uplinkLoad",
"uplinkSpeed",
"wanInfo"
],
"type": "object",
"properties": {
"downlinkLoad": {
"description": "1-octet positive integer representing the current percentage loading of the downlink WAN connection, scaled linearly with 255 representing 100 %, as measured over an interval the duration of which is reported in Load Measurement Duration. In cases where the downlink load is unknown to the AP, the value is set to zero.",
"description": "4-octet positive integer whose value is an estimate of the WAN Backhaul link current downlink speed in kilobits per second.",
"contentEncoding": "int32"
"description": "The LMD (Load Measurement Duration) field is a 2-octet positive integer representing the duration over which the Downlink Load and Uplink Load have been measured, in tenths of a second. When the actual load measurement duration is greater than the maximum value, the maximum value will be reported. The value of the LMD field is set to 0 when neither the uplink nor downlink load can be computed. When the uplink and downlink loads are computed over different intervals, the maximum interval is reported.",
"contentEncoding": "int32"
},
"uplinkLoad": {
"type": "integer",
"description": "1-octet positive integer representing the current percentage loading of the uplink WAN connection, scaled linearly with 255 representing 100 %, as measured over an interval, the duration of which is reported in Load Measurement Duration. In cases where the uplink load is unknown to the AP, the value is set to zero.",
"description": "4-octet positive integer whose value is an estimate of the WAN Backhaul link's current uplink speed in kilobits per second.",
"contentEncoding": "int32"
"description": "Info about WAN link status, link symmetricity and capacity currently used.",
"contentEncoding": "int32"
"title": "WebsockNotifConfig",
"type": "object",
"properties": {
"requestWebsocketUri": {
"type": "boolean",
"description": "Set to true by the service consumer to indicate that Websocket delivery is requested."
"type": "string",
"description": "Set by WAIS to indicate to the service consumer the Websocket URI to be used for delivering notifications."
"title": "WlanCapabilities",
"type": "object",
}
},
"InlineNotification": {
"title": "InlineNotification",
"required": [
"notificationType"
],
"type": "object",
"properties": {
"notificationType": {
"type": "string"
}
},
"discriminator": {
"propertyName": "notificationType",
"mapping": {
"AssocStaNotification": "#/components/schemas/AssocStaNotification",
"MeasurementReportNotification": "#/components/schemas/MeasurementReportNotification",
"StaDataRateNotification": "#/components/schemas/StaDataRateNotification"
}
}
},
"InlineSubscription": {
"title": "InlineSubscription",
"required": [
"subscriptionType"
],
"type": "object",
"properties": {
"subscriptionType": {
"type": "string"
}
},
"discriminator": {
"propertyName": "subscriptionType",
"mapping": {
"AssocStaNotification": "#/components/schemas/AssocStaNotification",
"MeasurementReportNotification": "#/components/schemas/MeasurementReportNotification",
"StaDataRateNotification": "#/components/schemas/StaDataRateNotification"
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
}
}
},
"Links": {
"title": "Links",
"required": [
"self"
],
"type": "object",
"properties": {
"self": {
"$ref": "#/components/schemas/LinkType"
}
},
"description": "Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests."
},
"Links1": {
"title": "Links1",
"required": [
"subscription"
],
"type": "object",
"properties": {
"subscription": {
"$ref": "#/components/schemas/LinkType"
}
},
"description": "Hyperlink related to the resource."
},
"Links4": {
"title": "Links4",
"required": [
"self"
],
"type": "object",
"properties": {
"self": {
"$ref": "#/components/schemas/LinkType"
}
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
"description": "Hyperlink related to the resource."
},
"Links6": {
"title": "Links6",
"required": [
"self"
],
"type": "object",
"properties": {
"self": {
"$ref": "#/components/schemas/LinkType"
}
},
"description": "List of hyperlinks related to the resource."
},
"MeasurementConfig1": {
"title": "MeasurementConfig1",
"required": [
"href",
"measurementId"
],
"type": "object",
"properties": {
"href": {
"type": "string",
"description": "The URI referring to a measurement configuration."
},
"measurementId": {
"type": "string",
"description": "Unique identifier allocated by the service consumer to identify measurement reports associated with this measurement configuration."
}
}
},
"NotificationEvent": {
"title": "NotificationEvent",
"required": [
"threshold",
"trigger"
],
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
"properties": {
"threshold": {
"type": "integer",
"description": "Number of connected stations threshold for trigger-based event reporting.",
"contentEncoding": "int32"
},
"trigger": {
"$ref": "#/components/schemas/Trigger"
}
},
"description": "Set for trigger-based event notification reporting."
},
"NotificationEvent1": {
"title": "NotificationEvent1",
"required": [
"trigger"
],
"type": "object",
"properties": {
"downlinkRateThreshold": {
"type": "integer",
"description": "Downlink data rate threshold for StaDataRate reporting.",
"contentEncoding": "int32"
},
"trigger": {
"$ref": "#/components/schemas/Trigger1"
},
"uplinkRateThreshold": {
"type": "integer",
"description": "Uplink data rate threshold for StaDataRate reporting.",
"contentEncoding": "int32"
}
},
"description": "Set for trigger-based event notification reporting."
},
"Subscription": {
"title": "Subscription",
"required": [
"href",
"subscriptionType"
],
"type": "object",
"properties": {
"href": {
"type": "string",
"description": "The URI referring to the subscription."
},
"subscriptionType": {
"type": "string",
"description": "Type of the subscription. The string shall be set according to the \"subscriptionType\" attribute of the associated subscription data type defined in 6.3.2, 6.3.3. and 6.3.5:\n“AssocStaSubscription”\n“StaDataRateSubscription”\n“MeasurementReportSubscription”"
}
}
},
"Trigger": {
"title": "Trigger",
"enum": [
1,
2
],
"type": "integer",
"description": "Trigger for the notification:\n1 = Notification issued when the number of connected stations is greater than or equal to the threshold.\n2 = Notification issued when the number of connected stations is less than or equal to the threshold.",
"examples": [
1
]
},
"Trigger1": {