3GPP Individual NWDAF Events Subscription (Document) API is one of 144 APIs that 3GPP publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Individual NWDAF Events Subscription (Document). The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
2 operations
across 1 path,
and defines 84 schemas.
It is described by OpenAPI 3.2.0, at version 1.2.0.
Requests are made against a single base URL, {apiRoot}/nnwdaf-eventssubscription/v1.
The identity and technical contract details declared by the specification.
RedundantTransmissionExpPerTS
object
The redundant transmission experience per Time Slot.
5 properties
3 required
TimeUnit
Possible values are: - MINUTE: Time unit is per minute. - HOUR: Time unit is per hour. - DAY: Time unit is per day.
UeCommunication
object
Represents UE communication information.
12 properties
PrevSubInfo
object
Information of the previous subscription.
5 properties
1 required
EventReportingRequirement
object
Represents the type of reporting that the subscription requires.
11 properties
TrafficInformation
object
Traffic information including UL/DL data rate and/or Traffic volume.
2 properties
ConsumerNfInformation
object
Represents the analytics consumer NF Information.
3 properties
TargetUeInformation
object
Identifies the target UE information.
4 properties
DnPerformanceReq
object
Represents other DN performance analytics requirements.
3 properties
OutputStrategy
Possible values are: - BINARY: Indicates that the analytics shall only be reported when the requested level of accuracy is reached within a cycle of periodic n…
RedundantTransmissionExpInfo
object
The redundant transmission experience related information. When subscribed event is "REDTRANSEXP", the "redTransInfos" attribute shall be included.
2 properties
1 required
WlanPerTsPerformanceInfo
object
WLAN performance information per Time Slot during the analytics target period.
7 properties
2 required
MatchingDirection
Possible values are: - ASCENDING: Threshold is crossed in ascending direction. - DESCENDING: Threshold is crossed in descending direction. - CROSSED: Threshold…
AnySlice
boolean
FALSE represents not applicable for all slices. TRUE represents applicable for all slices.
QosRequirement
object
Represents the QoS requirements.
6 properties
NetworkPerfRequirement
object
Represents a network performance requirement.
3 properties
1 required
ThresholdLevel
object
Represents a threshold level.
11 properties
PerfData
object
Represents DN performance data.
5 properties
ExceptionId
Possible values are: - UNEXPECTEDUELOCATION: Unexpected UE location - UNEXPECTEDLONGLIVEFLOW: Unexpected long-live rate flows - UNEXPECTEDLARGERATEFLOW: Unexpe…
RetainabilityThreshold
object
Represents a QoS flow retainability threshold.
3 properties
LoadLevelInformation
integer
Load level information of the network slice and the optionally associated network slice instance.
DnPerf
object
Represents DN performance for the application.
2 properties
1 required
NfStatus
object
Contains the percentage of time spent on various NF states.
3 properties
UserDataCongestionInfo
object
Represents the user data congestion information.
2 properties
1 required
ClassCriterion
object
Indicates the dispersion class criterion for fixed, camper and/or traveller UE, and/or the top-heavy UE dispersion class criterion.
3 properties
3 required
SliceLoadLevelInformation
object
Contains load level information applicable for one or several slices.
2 properties
2 required
ResourceUsage
object
The current usage of the virtual resources assigned to the NF instances belonging to a particular network slice instance.
3 properties
AnalyticsMetadataInfo
object
Contains analytics metadata information required for analytics aggregation.
4 properties
AppListForUeComm
object
Represents the analytics of the application list used by UE.
4 properties
1 required
NetworkPerfInfo
object
Represents the network performance information.
4 properties
DispersionInfo
object
Represents the Dispersion information. When subscribed event is "DISPERSION", the "disperInfos" attribute shall be included.
4 properties
4 required
ExceptionTrend
Possible values are: - UP: Up trend of the exception level. - DOWN: Down trend of the exception level. - UNKNOW: Unknown trend of the exception level. - STABLE…
NetworkPerfType
Possible values are: - GNBACTIVERATIO: Indicates that the network performance requirement is gNodeB active (i.e. up and running) rate. Indicates the ratio of g…
DatasetStatisticalProperty
Possible values are: - UNIFORMDISTDATA: Indicates the use of data samples that are uniformly distributed according to the different aspects of the requested an…
UeAnalyticsContextDescriptor
object
Contains information about available UE related analytics contexts.
2 properties
2 required
UeMobility
object
Represents UE mobility information.
4 properties
WlanPerformanceReq
object
Represents other WLAN performance analytics requirements.
4 properties
AbnormalBehaviour
object
Represents the abnormal behaviour information.
7 properties
1 required
DispersionRequirement
object
Represents the dispersion analytics requirements.
5 properties
1 required
TopApplication
object
Top application that contributes the most to the traffic.
2 properties
ServiceExperienceType
Possible values are: - VOICE: Indicates that the service experience analytics is for voice service. - VIDEO: Indicates that the service experience analytics is…
DispersionCollection
object
Dispersion collection per UE location or per slice.
11 properties
AdditionalMeasurement
object
Represents additional measurement information.
5 properties
RedTransExpOrderingCriterion
Possible values are: - TIMESLOTSTART: Indicates the order of time slot start. - REDTRANSEXP: Indicates the order of Redundant Transmission Experience.
Accuracy
Possible values are: - LOW: Low accuracy. - HIGH: High accuracy.
CongestionType
Possible values are: - USERPLANE: The congestion analytics type is User Plane. - CONTROLPLANE: The congestion analytics type is Control Plane. - USERANDCONTROL…
EventNotification
object
Represents a notification on events that occurred.
21 properties
1 required
QosSustainabilityInfo
object
Represents the QoS Sustainability information.
6 properties
AddressList
object
Represents a list of IPv4 and/or IPv6 addresses.
2 properties
DispersionType
Possible values are: - DVDA: Data Volume Dispersion Analytics. - TDA: Transactions Dispersion Analytics. - DVDAANDTDA: Data Volume Dispersion Analytics and Tra…
RatFreqInformation
object
Represents the RAT type and/or Frequency information.
6 properties
DispersionOrderingCriterion
Possible values are: - TIMESLOTSTART: Indicates the order of time slot start. - DISPERSION: Indicates the order of data/transaction dispersion. - CLASSIFICATIO…
ServiceExperienceInfo
object
Represents service experience information.
11 properties
1 required
NwdafEvent
Possible values are: - SLICELOADLEVEL: Indicates that the event subscribed is load level information of Network Slice - NETWORKPERFORMANCE: Indicates that the…
TrafficCharacterization
object
Identifies the detailed traffic characterization.
6 properties
WlanOrderingCriterion
Possible values are: - TIMESLOTSTART: Indicates the order of time slot start. - NUMBEROFUES: Indicates the order of number of UEs. - RSSI: Indicates the order…
NnwdafEventsSubscription
object
Represents an Individual NWDAF Event Subscription resource.
8 properties
1 required
EventSubscription
object
Represents a subscription to a single event.
34 properties
1 required
LocationInfo
object
Represents UE location information.
3 properties
1 required
WlanPerSsIdPerformanceInfo
object
The WLAN performance per SSID.
2 properties
2 required
NsiIdInfo
object
Represents the S-NSSAI and the optionally associated Network Slice Instance(s).
1 property
1 required
AnalyticsMetadataIndication
object
Contains analytics metadata information requested to be used during analytics generation.
3 properties
FailureEventInfo
object
Contains information on the event for which the subscription is not successful.
2 properties
2 required
DispersionClass
Possible values are: - FIXED: Dispersion class as fixed UE its data or transaction usage at a location or a slice, is higher than its class threshold set for i…
NumberAverage
object
Represents average and variance information.
2 properties
2 required
AnalyticsMetadata
Possible values are: - NUMOFSAMPLES: Number of data samples used for the generation of the output analytics. - DATAWINDOW: Data time window of the data samples…
RedundantTransmissionExpReq
object
Represents other redundant transmission experience analytics requirements.
2 properties
IpEthFlowDescription
object
Contains the description of an Uplink and/or Downlink Ethernet flow.
2 properties
NotificationMethod
Possible values are: - PERIODIC: The subscribe of NWDAF Event is periodically. The periodic of the notification is identified by repetitionPeriod defined in cl…
CongestionInfo
object
Represents the congestion information.
5 properties
2 required
DnPerfInfo
object
Represents DN performance information.
5 properties
1 required
WlanPerformanceInfo
object
The WLAN performance related information.
1 property
1 required
RankingCriterion
object
Indicates the usage ranking criterion between the high, medium and low usage UE.
2 properties
2 required
DnPerfOrderingCriterion
Possible values are: - AVERAGETRAFFICRATE: Indicates the average traffic rate. - MAXIMUMTRAFFICRATE: Indicates the maximum traffic rate. - AVERAGEPACKETDELAY:…
BwRequirement
object
Represents bandwidth requirements.
5 properties
1 required
SessInactTimerForUeComm
object
Represents the N4 Session inactivity timer.
2 properties
2 required
ExpectedAnalyticsType
Possible values are: - MOBILITY: Mobility related abnormal behaviour analytics is expected by the consumer. - COMMUN: Communication related abnormal behaviour…
NsiLoadLevelInfo
object
Represents the network slice and optionally the associated network slice instance and the load level information.
8 properties
2 required
ApplicationVolume
object
Application data volume per Application Id.
1 property
1 required
AnalyticsSubset
Possible values are: - NUMOFUEREG: The number of UE registered. This value is only applicable to NSILOADLEVEL event. - NUMOFPDUSESSESTBL: The number of PDU ses…
Exception
object
Represents the Exception information.
3 properties
1 required
NwdafFailureCode
Possible values are: - UNAVAILABLEDATA: Indicates the requested statistics information for the event is rejected since necessary data to perform the service is…
NfLoadLevelInformation
object
Represents load level information of a given NF instance.
11 properties
CircumstanceDescription
object
Contains the description of a circumstance.
2 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs 3GPP publishes across the network.