NWDAF Events Subscriptions

/subscriptions

POST

Creates a new Individual NWDAF Event Subscription resource.

Individual NWDAF Event Subscription

/subscriptions/{subscriptionId}

DELETE

Deletes an Individual NWDAF Event Subscription identified by subresource {subscriptionId}.

PUT

Modifies an existing Individual Event Subscription subresource.

NWDAF Event Subscription Transfers

/transfers

POST

Provides information about the requested analytics subscription transfer(s), potentially creating a new Individual NWDAF Event Subscription Transfer resource.

Individual NWDAF Event Subscription Transfer

/transfers/{transferId}

DELETE

Deletes an Individual NWDAF Event Subscription Transfer resource identified by subresource {transferId}.

PUT

Modifies an existing Individual NWDAF Event Subscription Transfer resource.

apiRoot

string

See clause 5.1.1

n/a

NnwdafEventsSubscription

M

1

Creates a new Individual NWDAF Event Subscription resource.

NnwdafEventsSubscription

M

1

201 Created

The creation of an Individual NWDAF Event Subscription resource is confirmed and a representation of that resource is returned.

ProblemDetails

O

0..1

400 Bad Request

(NOTE 2)

ProblemDetails

O

0..1

403 Forbidden

(NOTE 2)

ProblemDetails

O

0..1

500 Internal Server Error

(NOTE 2)

NOTE 1: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] also apply.

NOTE 2: Failure cases are described in clause 5.1.7.

Location

string

M

1

Contains the URI of the newly created resource, according to the structure: {apiRoot}/nnwdaf-eventssubscription/<apiVersion>/subscriptions/{subscriptionId}.

apiRoot

string

See clause 5.1.1.

subscriptionId

string

Identifies a subscription to the Nnwdaf_EventsSubscription service.

n/a

n/a

n/a

204 No Content

Successful case: The Individual NWDAF Event Subscription resource matching the subscriptionId was deleted.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection, during Individual NWDAF Event Subscription deletion. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NWDAF (service) instance.

Applicable if the feature "ES3XX" is supported.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection, during Individual NWDAF Event Subscription deletion. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NWDAF (service) instance.

Applicable if the feature "ES3XX" is supported.

NOTE: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] also apply.

Location

string

M

1

An alternative URI of the resource located in an alternative NWDAF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located in an alternative NWDAF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

n/a

NnwdafEventsSubscription

M

1

Parameters to replace a subscription to NWDAF Event Subscription resource.

NnwdafEventsSubscription

M

1

200 OK

The Individual NWDAF Event Subscription resource was modified successfully and a representation of that resource is returned.

n/a

204 No Content

The Individual NWDAF Event Subscription resource was modified successfully.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection, during Individual NWDAF Event Subscription modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NWDAF (service) instance.

Applicable if the feature "ES3XX" is supported.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection, during Individual NWDAF Event Subscription modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NWDAF (service) instance.

Applicable if the feature "ES3XX" is supported.

ProblemDetails

O

0..1

400 Bad Request

(NOTE 2)

ProblemDetails

O

0..1

500 Internal Server Error

(NOTE 2)

NOTE 1: The mandatory HTTP error status codes for the PUT method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] also apply.

NOTE 2: Failure cases are described in clause 5.1.7.

Location

string

M

1

An alternative URI of the resource located in an alternative NWDAF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located in an alternative NWDAF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

apiRoot

string

See clause 5.1.1

n/a

AnalyticsSubscriptionsTransfer

M

1

Information about analytics subscription(s) that are requested to be transferred or prepared for transfer.

AnalyticsSubscriptionsTransfer

M

1

201 Created

The creation of an Individual NWDAF Event Subscription Transfer resource is confirmed and a representation of that resource is returned.

n/a

204 No Content

The receipt of the information about analytics subscription(s) that are requested to be transferred and the ability to handle this information (e.g. execute the steps required to transfer an analytics subscription directly) is confirmed.

NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] also apply.

Location

string

M

1

Contains the URI of the newly created resource, according to the structure: {apiRoot}/nnwdaf-eventssubscription/<apiVersion>/transfers/{transferId}.

apiRoot

string

See clause 5.1.1.

transferId

string

Identifies a request to transfer subscription(s) of the Nnwdaf_EventsSubscription service.

n/a

n/a

n/a

204 No Content

Successful case: The Individual NWDAF Event Subscription Transfer resource matching the transferId was deleted.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection, during Individual NWDAF Event Subscription Transfer deletion. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NWDAF (service) instance.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection, during Individual NWDAF Event Subscription Transfer deletion. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NWDAF (service) instance.

NOTE: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] also apply.

Location

string

M

1

An alternative URI of the resource located in an alternative NWDAF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located in an alternative NWDAF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

n/a

AnalyticsSubscriptionsTransfer

M

1

Parameters to replace in an Individual NWDAF Event Subscription Transfer resource.

n/a

204 No Content

The Individual NWDAF Event Subscription Transfer resource was modified successfully.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection, during Individual NWDAF Event Subscription Transfer modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NWDAF (service) instance.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection, during Individual NWDAF Event Subscription Transfer modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NWDAF (service) instance.

NOTE: The mandatory HTTP error status codes for the PUT method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] also apply.

Location

string

M

1

An alternative URI of the resource located in an alternative NWDAF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located in an alternative NWDAF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

Event Notification

{notificationURI}

POST

Reports one or several observed Events.

notificationURI

Uri

The Notification Uri as assigned within the Individual NWDAF Event Subscription and described within the NnwdafEventsSubscription type (see table 5.1.6.2.2-1).

array(NnwdafEventsSubscriptionNotification)

M

1..N

Provides Information about observed Events or the successful analytics subscription transfer.

n/a

204 No Content

The receipt of the Notification is acknowledged.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection, during the event notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative NF consumer (service) instance where the notification should be sent.

Applicable if the feature "ES3XX" is supported.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection, during the event notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative NF consumer (service) instance where the notification should be sent.

Applicable if the feature "ES3XX" is supported.

NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] also apply.

Location

string

M

1

An alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the notification request is redirected.

Location

string

M

1

An alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the notification request is redirected.

AbnormalBehaviour

5.1.6.2.15

Represents the abnormal behaviour information.

AbnormalBehaviour

Accuracy

5.1.6.3.5

Represents the preferred level of accuracy of the analytics.

AdditionalMeasurement

5.1.6.2.26

Represents additional measurement information.

AbnormalBehaviour

AddressList

5.1.6.2.28

Represents a list of IPv4 and/or IPv6 addresses.

AbnormalBehaviour

AnalyticsContextIdentifier

5.1.6.2.43

Contains information about available analytics contexts.

AnaSubTransfer

AnalyticsMetadata

5.1.6.3.14

Represents the types of analytics metadata information that can be requested.

Aggregation

AnalyticsMetadataIndication

5.1.6.2.36

Contains analytics metadata values indicated to be used during analytics generation.

Aggregation

AnalyticsMetadataInfo

5.1.6.2.37

Contains analytics metadata information required for analytics aggregation.

Aggregation

AnalyticsSubscriptionsTransfer

5.1.6.2.40

Contains information about a request to transfer analytics subscriptions.

AnaSubTransfer

AnalyticsSubset

5.1.6.3.18

Analytics subset used to indicate the content of the analytics.

EneNA

AnySlice

5.1.6.3.2

Represents the any slices.

ApplicationVolume

5.1.6.2.55

Application data volume per application Id.

Dispersion

AppListForUeComm

5.1.6.2.64

Represents the analytics of the application list used by UE.

UeCommunicationExt

BwRequirement

5.1.6.2.25

Represents bandwidth requirement.

ServiceExperience

ClassCriterion

5.1.6.2.51

Disperion class criterion.

Dispersion

CircumstanceDescription

5.1.6.2.29

Contains the description of a circumstance.

AbnormalBehaviour

CongestionInfo

5.1.6.2.18

Represents the congestion information

UserDataCongestion

CongestionType

5.1.6.3.8

Identification congestion analytics type.

UserDataCongestion

ConsumerNfInformation

5.1.6.2.49

Represents the analytics consumer NF Information.

AnaSubTransfer

DatasetStatisticalProperty

5.1.6.3.15

Dataset statistical properties of the data used to generate the analytics.

Aggregation

DnPerf

5.1.6.2.46

Represents DN performance information.

DnPerformance

DnPerfInfo

5.1.6.2.45

Represents DN performances for the application.

DnPerformance

DnPerfOrderingCriterion

5.1.6.3.25

Ordering criterion for the list of DN performance analytics.

DnPerformance

DnPerformanceReq

5.1.6.2.66

Represents DN performance analytics requirement.

DnPerformance

DispersionClass

5.1.6.3.20

Dispersion class.

Dispersion

DispersionCollection

5.1.6.2.54

Dispersion collections per UE location or or per slice.

Dispersion

DispersionInfo

5.1.6.2.53

Dispersion analytics information.

Dispersion

DispersionRequirement

5.1.6.2.50

Dispersion analytics requirement.

Dispersion

DispersionType

5.1.6.3.19

Dispersion type.

Dispersion

DispersionOrderingCriterion

5.1.6.3.21

Ordering criterion for the list of Dispersion.

Dispersion

EventNotification

5.1.6.2.5

Describes Notifications about events that occurred.

EventReportingRequirement

5.1.6.2.7

Represents the type of reporting the subscription requires.

EventSubscription

5.1.6.2.3

Represents the subscription to a single event.

Exception

5.1.6.2.16

Describes the Exception information.

AbnormalBehaviour

ExceptionId

5.1.6.3.6

Describes the Exception Id.

AbnormalBehaviour

ExceptionTrend

5.1.6.3.7

Describes the Exception Trend.

AbnormalBehaviour

ExpectedAnalyticsType

5.1.6.3.11

Represents expected UE analytics type.

AbnormalBehaviour

FailureEventInfo

5.1.6.2.35

Contains information on the event for which the subscription is not successful.

IpEthFlowDescription

5.1.6.2.27

Contains the description of an Uplink and/or Downlink Ethernet flow.

AbnormalBehaviour

LoadLevelInformation

5.1.6.3.2

Represents load level information of the network slice and the optionally associated network slice instance.

LocationInfo

5.1.6.2.11

Represents UE location information.

UeMobility

MatchingDirection

5.1.6.3.12

Defines the matching direction when crossing a threshold.

NfLoad, QoSSustainability, UserDataCongestion, NetworkPerformance

Dispersion

RedundantTransmissionExp

WlanPerformance

ServiceExperienceExt

MLModelInfo

5.1.6.2.69

The information of the ML model.

AnaSubTransfer

ModelInfo

5.1.6.2.42

Contains information about an ML model.

AnaSubTransfer

NetworkPerfInfo

5.1.6.2.23

Represents the network performance information.

NetworkPerformance

NetworkPerfRequirement

5.1.6.2.22

Represents a network performance requirement.

NetworkPerformance

NetworkPerfType

5.1.6.3.10

Represents the network performance types.

NetworkPerformance

NfLoadLevelInformation

5.1.6.2.31

Represents load level information of a given NF instance.

NfLoad

NfStatus

5.1.6.2.32

Provides the percentage of time spent on various NF states.

NfLoad

NnwdafEventsSubscription

5.1.6.2.2

Represents an Individual NWDAF Event Subscription resource.

NnwdafEventsSubscriptionNotification

5.1.6.2.4

Represents an Individual NWDAF Event Subscription Notification resource.

NumberAverage

5.1.6.2.38

Represents average and variance information.

NsiLoadExt

NwdafEvent

5.1.6.3.4

Describes the NWDAF Events.

NwdafFailureCode

5.1.6.3.13

Identifies the failure reason.

NotificationMethod

5.1.6.3.3

Represents the notification methods that can be subscribed.

NsiIdInfo

5.1.6.2.33

Represents the S-NSSAI and the optionally associated Network Slice Instance Identifier(s).

ServiceExperience

NsiLoad

DnPerformance

NsiLoadLevelInfo

5.1.6.2.34

Represents the load level information for an S-NSSAI and the optionally associated network slice instance.

NsiLoad

ObservedRedundantTransExp

5.1.6.2.70

Represents the observed Redundant Transmission Experience.

RedundantTransmissionExp

OutputStrategy

5.1.6.3.16

Represents the output strategy used for the reporting of the analytics.

Aggregation

PerfData

5.1.6.2.47

Represents DN performance information.

DnPerformance

PrevSubInfo

5.1.6.2.68

Information of the previous subscription.

AnaCtxTransfer

QosRequirement

5.1.6.2.20

Represents the QoS requirements.

QoSSustainability

QosSustainabilityInfo

5.1.6.2.19

Represents the QoS Sustainability information.

QoSSustainability

RankingCriterion

5.1.6.2.52

Ranking criterion.

Dispersion

RatFreqInformation

5.1.6.2.67

Represents the RAT type and/or Frequency information.

ServiceExperienceExt

RedTransExpOrderingCriterion

5.1.6.3.22

Ordering criterion for the list of Redundant Transmission Experience.

RedundantTransmissionExp

RedundantTransmissionExpInfo

5.1.6.2.57

Redundant transmission experience analytics information.

RedundantTransmissionExp

RedundantTransmissionExpPerTS

5.1.6.2.58

Redundant Transmission Experience per Time Slot.

RedundantTransmissionExp

RedundantTransmissionExpReq

5.1.6.2.56

Redundant transmission experience analytics requirement.

RedundantTransmissionExp

ResourceUsage

5.1.6.2.48

The current usage of the virtual resources assigned to the NF instances belonging to a particular network slice instance.

NsiLoadExt

RetainabilityThreshold

5.1.6.2.21

Represents a QoS flow retainability threshold.

QoSSustainability

ServiceExperienceInfo

5.1.6.2.24

Represents the service experience information.

ServiceExperience

ServiceExperienceType

5.1.6.3.24

Represents the type of Service Experience Analytics.

ServiceExperienceExt

SessInactTimerForUeComm

5.1.6.2.65

Represents the N4 Session inactivity timer.

UeCommunicationExt

SliceLoadLevelInformation

5.1.6.2.6

Represents the slices and their load level information.

SubscriptionTransferInfo

5.1.6.2.41

Contains information about subscriptions that are requested to be transferred.

AnaSubTransfer

TargetUeInformation

5.1.6.2.8

Identifies the target UE information.

ServiceExperience

NfLoad

NetworkPerformance

UserDataCongestion

UeMobility

UeCommunication

AbnormalBehaviour

QoSSustainability

Dispersion

RedundantTransmissionExp

WlanPerformance

DnPerformance

TermCause

5.1.6.3.26

Represents a cause for requesting to terminate an analytics subscription.

TermRequest

ThresholdLevel

5.1.6.2.30

Describe a threshold level.

UserDataCongestion

NfLoad

DnPerformance

ServiceExperienceExt

TimeUnit

5.1.6.3.9

Represents the unit for the session active time.

QoSSustainability

TopApplication

5.1.6.2.39

Top application that contributes the most to the traffic.

UserDataCongestionExt

TrafficCharacterization

5.1.6.2.14

Identifies the detailed traffic characterization.

UeCommunication

TrafficInformation

5.1.6.2.63

Traffic information including UL/DL data rate and/or Traffic volume.

WlanPerformance

TransferRequestType

5.1.6.3.17

Represents the type of a request for analytics subscription transfer.

AnaSubTransfer

UeAnalyticsContextDescriptor

5.1.6.2.44

Contains information about available UE related analytics contexts.

AnaSubTransfer

UeCommunication

5.1.6.2.13

Represents UE communication information.

UeCommunication

UeMobility

5.1.6.2.10

Represents UE mobility information.

UeMobility

UserDataCongestionInfo

5.1.6.2.17

Represents the user data congestion information.

UserDataCongestion

WlanOrderingCriterion

5.1.6.3.23

Ordering criterion for the list of WLAN performance information.

WlanPerformance

WlanPerformanceReq

5.1.6.2.59

WLAN performance analytics requirement.

WlanPerformance

WlanPerformanceInfo

5.1.6.2.60

WLAN performance analytics information.

WlanPerformance

WlanPerSsIdPerformanceInfo

5.1.6.2.61

WLAN performance information per SSID of WLAN access points deployed in the Area of Interest.

WlanPerformance

WlanPerTsPerformanceInfo

5.1.6.2.62

WLAN performance information per Time Slot during the analytics target period.

WlanPerformance

5Qi

3GPP TS 29.571 [8]

Identifies the 5G QoS identifier

QoSSustainability

AddrFqdn

3GPP TS 29.517 [22]

Represents the IP address or FQDN of the Application Server.

DnPerformance

ServiceExperienceExt

ApplicationId

3GPP TS 29.571 [8]

Identifies the application identifier.

ServiceExperience

UeCommunication

AbnormalBehaviour

Dispersion

DnPerformance

ArfcnValueNR

3GPP TS 29.571 [8]

Integer value indicating the ARFCN applicable for a downlink, uplink or bi-directional (TDD) NR global frequency raster.

Minimum = 0. Maximum = 3279165.

ServiceExperienceExt

BitRate

3GPP TS 29.571 [8]

String representing a bit rate that shall be formatted as follows:

pattern: "^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$"

Examples:

"125 Mbps", "0.125 Gbps", "125000 Kbps".

ServiceExperience

QoSSustainability

WlanPerformance

DnPerformance

DateTime

3GPP TS 29.571 [8]

Identifies the time.

Dnai

3GPP TS 29.571 [8]

Identifies a user plane access to one or more DN(s).

ServiceExperience

DnPerformance

Dnn

3GPP TS 29.571 [8]

Identifies the DNN.

ServiceExperience

AbnormalBehaviour

UeCommunication

DnPerformance

SMCCE

DurationSec

3GPP TS 29.571 [8]

EthFlowDescription

3GPP TS 29.514 [21]

UeCommunication

AbnormalBehaviour

ExpectedUeBehaviourData

3GPP TS 29.503 [23]

AbnormalBehaviour

Float

3GPP TS 29.571 [8]

FlowDescription

3GPP TS 29.514 [21]

UeCommunication

AbnormalBehaviour

FlowInfo

3GPP TS 29.122 [19]

UserDataCongestionExt

Gpsi

3GPP TS 29.571 [8]

The GPSI for an UE.

UserDataCongestionExt

GroupId

3GPP TS 29.571 [8]

Identifies a group of UEs.

UeMobility

UeCommunication NetworkPerformance

AbnormalBehaviour

ServiceExperience

Dispersion

RedundantTransmissionExp

WlanPerformance

Ipv4Addr

3GPP TS 29.571 [8]

Ipv6Addr

3GPP TS 29.571 [8]

NetworkAreaInfo

3GPP TS 29.554 [18]

Identifies the network area.

ServiceExperience

QoSSustainability

AbnormalBehaviour

UeMobility

UserDataCongestion

NetworkPerformance

NsiLoadExt

NfLoadExt

Dispersion

RedundantTransmissionExp

WlanPerformance

EneNA

DnPerformance

NfInstanceId

3GPP TS 29.571 [8]

Identifies an NF instance.

NfLoad

NfSetId

3GPP TS 29.571 [8]

Identifies an NF Set instance.

NfLoad

NFType

3GPP TS 29.510 [12]

Indentifies a type of NF.

NfLoad

NsiId

3GPP TS 29.531 [24]

Identifies a Network Slice Instance.

ServiceExperience

NsiLoad

DnPerformance

PacketDelBudget

3GPP TS 29.571 [8]

QoSSustainability

DnPerformance

PacketErrRate

3GPP TS 29.571 [8]

QoSSustainability

PacketLossRate

3GPP TS 29.517 [22]

Indicates Packet Loss Rate.

DnPerformance

PduSessionId

3GPP TS 29.571 [8]

Indentifies PDU Session

ProblemDetails

3GPP TS 29.571 [8]

Used in error responses to provide more detailed information about an error.

QosResourceType

3GPP TS 29.571 [8]

Identifies the resource type in QoS characteristics.

QoSSustainability

RatType

3GPP TS 29.571 [8]

Identifies the RAT type.

ServiceExperienceExt

RedirectResponse

3GPP TS 29.571 [8]

Contains redirection related information.

ES3XX

ReportingInformation

3GPP TS 29.523 [20]

Represents the type of reporting the subscription requires.

SamplingRatio

3GPP TS 29.571 [8]

ScheduledCommunicationTime

3GPP TS 29.122 [19]

UeMobility UeCommunication

SmcceInfo

5.2.6.2.12

Represents the analytics of Session Management Congestion Control Experience information.

SMCCE

Snssai

3GPP TS 29.571 [8]

Identifies the S-NSSAI (Single Network Slice Selection Assistance Information).

Supi

3GPP TS 29.571 [8]

The SUPI for an UE.

ServiceExperience,

NfLoad

NetworkPerformance,

UserDataCongestion

UeMobility

UeCommunication

AbnormalBehaviour

Dispersion

RedundantTransmissionExp

WlanPerformance

SupportedFeatures

3GPP TS 29.571 [8]

Used to negotiate the applicability of the optional features defined in table 5.1.8-1.

SvcExperience

3GPP TS 29.517 [22]

ServiceExperience

Tai

3GPP TS 29.571 [8]

Tracking Area Information.

AnaSubTransfer

TimeWindow

3GPP TS 29.122 [19]

Uinteger

3GPP TS 29.571 [8]

Unsigned Integer, i.e. only value 0 and integers above 0 are permissible.

UpfInformation

3GPP TS 29.508 [29]

The information of the UPF serving the UE.

ServiceExperienceExt

DnPerformance

Uri

3GPP TS 29.571 [8]

UserLocation

3GPP TS 29.571 [8]

UeMobility

Dispersion

Volume

3GPP TS 29.122 [19]

UeCommunication

AbnormalBehaviour

Dispersion

WlanPerformance

eventSubscriptions

array(EventSubscription)

M

1..N

Subscribed events.

evtReq

ReportingInformation

O

0..1

Represents the reporting requirements of the event subscription. (NOTE 1, NOTE 2)

If omitted, the default values within the ReportingInformation data type apply.

notificationURI

Uri

C

0..1

Identifies the recipient of Notifications sent by the NWDAF.

This parameter shall be supplied by the NF service consumer in the HTTP POST requests that create the subscriptions for event notifications and in the HTTP PUT requests that update the subscriptions for event notifications.

notifCorrId

string

O

0..1

Notification correlation identifier.

EneNA

eventNotifications

array(EventNotification)

C

1..N

Notifications about Individual Events.

Shall only be present if the immediate reporting indication in the "immRep" attribute within the "evtReq" attribute sets to true in the event subscription, and the reports are available.

failEventReports

array(FailureEventInfo)

O

1..N

Supplied by the NWDAF. When available, shall contain the event(s) for which the subscription is not successful including the failure reason(s).

consNfInfo

ConsumerNfInformation

O

0..1

Represents the analytics consumer NF Information.

AnaSubTransfer

prevSub

PrevSubInfo

O

0..1

Contains information about the previous analytics subscription that the NF service consumer had with the source NWDAF.

(NOTE 3)

AnaCtxTransfer

supportedFeatures

SupportedFeatures

C

0..1

List of Supported features used as described in clause 5.1.8.

This parameter shall be supplied by NF service consumer in the POST request that request the creation of an NWDAF Event Subscriptions resource, and shall be supplied by the NWDAF in the reply of corresponding request.

NOTE 1: If the "evtReq" attribute (of data type ReportingInformation) is provided and contains the "notifMethod" attribute, the notification method indicated by the "notifMethod" attribute within the ReportingInformation data type takes preference over the notification method indicated by the "notificationMethod" attribute within the EventSubscription data type.

NOTE 2: If the "evtReq" attribute (of data type ReportingInformation) is provided and contains the "repPeriod" attribute, the periodic reporting time indicated by the "repPeriod" attribute in the ReportingInformation data type takes preference over the periodic reporting time indicated by the "repetitionPeriod" attribute in the EventSubscription data type.

NOTE 3: The "prevSub" attribute may be used by the NWDAF to derive analytics context identifier(s), which may be used in the Nnwdaf_AnalyticsInfo_ContextTransfer service operation invoked by the NWDAF.

anySlice

AnySlice

C

0..1

Default is "FALSE". (NOTE 1)

appIds

array(ApplicationId)

C

1..N

Represents the Application Identifier(s) to which the subscription applies.

The absence of appIds means subscription to all applications. (NOTE 8)

ServiceExperience

UeCommunication

AbnormalBehaviour

Dispersion

DnPerformance

dnns

array(Dnn)

C

1..N

Represents the DNN(s) to which the subscription applies. Each DNN is a full DNN with both the Network Identifier and Operator Identifier, or a DNN with the Network Identifier only.

The absence of dnns means subscription to all DNNs. (NOTE 8)

ServiceExperience, AbnormalBehaviour

UeCommunication

RedundantTransmissionExp

DnPerformance

SMCCE

dnais

array(Dnai)

C

1..N

Represents the Data Network Access Identifier(s) of user plane access to DN(s) which the subscription applies.

ServiceExperience

DnPerformance

event

NwdafEvent

M

1

Event that is subscribed.

extraReportReq

EventReportingRequirement

O

0..1

The extra event reporting requirement information.

ladnDnns

array(Dnn)

O

1..N

LADN DNN(s) to indicate the LADN service area(s) as the AoI(s).

UeMobilityExt

loadLevelThreshold

integer

C

0..1

Indicates that the NWDAF shall report the corresponding network slice load level to the NF service consumer where the load level of the network slice identified by snssais is reached. (NOTE 4)

May be included when subscribed event is "SLICE_LOAD_LEVEL".

Minimum = 0. Maximum = 100.

matchingDir

MatchingDirection

O

0..1

A matching direction may be provided alongside a threshold. If omitted, the default value is CROSSED.

NfLoad, QoSSustainability, UserDataCongestion, NetworkPerformance, NsiLoadExt

nfLoadLvlThds

array(ThresholdLevel)

C

1..N

Shall be supplied in order to start reporting when an average load level is reached. (NOTE 4)

NfLoad

networkArea

NetworkAreaInfo

C

0..1

Identification of network area to which the subscription applies.

The absence of networkArea means subscription to all network areas. (NOTE 7, NOTE 8)

ServiceExperience

UeMobility

UeCommunication

QoSSustainability

AbnormalBehaviour

UserDataCongestion

NetworkPerformance

NsiLoadExt

NfLoadExt

Dispersion

RedundantTransmissionExp

WlanPerformance

DnPerformance

visitedAreas

array(NetworkAreaInfo)

O

1..N

Indicates the visited network area(s) which the UEs had previously been in at least one of the Visited Area(s) of Interest.

(NOTE 10)

UeMobilityExt

maxTopAppUlNbr

Uinteger

O

0..1

Indicates the requested maximum number of top applications that contribute the most to the traffic in Uplink direction. Minimum = 1.

May be included when one of the elements in the "listOfAnaSubsets" attribute is set to LIST_OF_TOP_APP_UL.

UserDataCongestionExt

maxTopAppDlNbr

Uinteger

O

0..1

Indicates the requested maximum number of top applications that contribute the most to the traffic in Downlink direction. Minimum = 1.

May be included when one of the elements in the "listOfAnaSubsets" attribute is set to LIST_OF_TOP_APP_DL.

UserDataCongestionExt

nfInstanceIds

array(NfInstanceId)

O

1..N

Identification(s) of NF instance(s).

NfLoad

nfSetIds

array(NfSetId)

O

1..N

Identification(s) of NF instance set(s).

NfLoad

nfTypes

array(NFType)

O

1..N

Identification(s) of NF type(s). (NOTE 13)

NfLoad

NsiLoadExt

notificationMethod

NotificationMethod

O

0..1

Indicate the notification method. (NOTE 2)

nsiIdInfos

array(NsiIdInfo)

O

1..N

Each element identifies the S-NSSAI and the optionally associated network slice instance(s).

May be included when subscribed event is "NSI_LOAD_LEVEL",

"SERVICE_EXPERIENCE" or "DN_PERFORMANCE".

(NOTE 1)

ServiceExperience

NsiLoad

DnPerformance

nsiLevelThrds

array(Uinteger)

O

1..N

Identifies the load threshold for each S-NSSAI or S-NSSAI and the optionally associated network slice instance identified by the "nsiIds" attribute within the "nsiIdInfos" attribute.

(NOTE 4)

Minimum = 0. Maximum = 100.

NsiLoad

qosRequ

QosRequirement

C

0..1

Indicates the QoS requirements. It shall be included when subscribed event is "QOS_SUSTAINABILITY".

QoSSustainability

qosFlowRetThds

array(RetainabilityThreshold)

C

1..N

Represents the QoS flow retainability thresholds. Shall be supplied for the 5QI ("5qi" in "qosRequ") or resource type ("resType" in "qosRequ") of GBR resource type. (NOTE 4)

QoSSustainability

ranUeThrouThds

array(BitRate)

C

1..N

Represents the RAN UE throughput thresholds.

Shall be supplied for the 5QI ("5qi" in "qosRequ") or resource type ("resType" in "qosRequ") of non-GBR resource type. (NOTE 4)

QoSSustainability

repetitionPeriod

DurationSec

C

0..1

Shall be supplied for notification method "PERIODIC" by the "notificationMethod" attribute.

snssais

array(Snssai)

C

1..N

Identification(s) of network slice(s) to which the subscription applies. (NOTE 1, NOTE 8)

tgtUe

TargetUeInformation

O

0..1

Identifies target UE information.

(NOTE 3)

congThresholds

array(ThresholdLevel)

C

1..N

Represents the congestion threshold levels. (NOTE 4)

UserDataCongestion

nwPerfRequs

array(NetworkPerfRequirement)

C

1..N

Represents the network performance requirements. This attribute shall be included when subscribed event is "NETWORK_PERFORMANCE".

It may only be present if "appIds" attribute is provided

NetworkPerformance

bwRequs

array(BwRequirement)

O

1..N

Represents the bandwidth requirement for each application.

ServiceExperience

excepRequs

array(Exception)

C

1..N

Represents a list of Exception Ids with associated thresholds. May only be present when subscribed event is "ABNORMAL_BEHAVIOUR".

(NOTE 5, NOTE 6, NOTE 8)

AbnormalBehaviour

exptAnaType

ExpectedAnalyticsType

C

0..1

Represents expected UE analytics type.

It shall not be present if the "excepRequs" attribute is provided. (NOTE 6, NOTE 8)

AbnormalBehaviour

exptUeBehav

ExpectedUeBehaviourData

O

0..1

Represents expected UE behaviour.

AbnormalBehaviour

ratFreqs

array(RatFreqInformation)

O

1..N

Identification(s) of the RAT type(s) and/or frequency(ies) of UE’s serving cell(s) which the subscriptiont applies. (NOTE 9)

ServiceExperienceExt

listOfAnaSubsets

array(AnalyticsSubset)

O

1..N

The list of analytics subsets can be used to indicate the content of the analytics.

EneNA

disperReqs

array(DispersionRequirement)

O

1..N

Represents the dispersion analytics requirements.

Dispersion

redTransReqs

array(RedundantTransmissionExpReq)

O

1..N

Represents the redundant transmission experience analytics requirements.

RedundantTransmissionExp

wlanReqs

array(WlanPerformanceReq)

O

1..N

Represents other WLAN performance analytics requirements. If the attribute contains no content, may take default handling action.

WlanPerformance

upfInfo

UpfInformation

O

0..1

Identifies the UPF. (NOTE 12)

ServiceExperienceExt

DnPerformance

appServerAddrs

array(AddrFqdn)

C

1..N

Each element represents the Application Server Instance (IP address/FQDN of the Application Server). (NOTE 11)

ServiceExperienceExt

DnPerformance

dnPerfReqs

array(DnPerformanceReq)

O

1..N

Represents the DN performance analytics requirements.

DnPerformance

NOTE 1: The "anySlice" attribute is not applicable to features "UeMobility" and "NetworkPerformance". The "snssais" attribute is not applicable to features "ServiceExperience", "NsiLoad", "UeMobility" and "NetworkPerformance". When subscribed event is "SLICE_LOAD_LEVEL", the identifications of network slices, either information about slice(s) identified by "snssais", or "anySlice" set to "TRUE" shall be included. When subscribed event is "QOS_SUSTAINABILITY", "NF_LOAD", "UE_COMM", "ABNORMAL_BEHAVIOUR", "USER_DATA_CONGESTION", "DISPERSION" or "RED_TRANS_EXP", the identifications of network slices identified by "snssais" is optional. When subscribed event is "NSI_LOAD_LEVEL", "SERVICE_EXPERIENCE" or "DN_PERFORMANCE", either the "nsiIdInfos" attribute or "anySlice" set to "TRUE" shall be included.

NOTE 2: When notificationMethod is not supplied, the default value is "THRESHOLD".

NOTE 3: Applicability is further described in the corresponding data type.

NOTE 4: This property shall be provided if the "notifMethod" in "evtReq" is set to "ON_EVENT_DETECTION" or "notificationMethod" in "eventSubscriptions" is set to "THRESHOLD" or omitted.

NOTE 5: Only "excepId" and "excepLevel" within the Exception data type apply to the "excepRequs" attribute within EventSubscription data type.

NOTE 6: Either "excepRequs" or "exptAnaType" shall be provided if subscribed event is "ABNORMAL_BEHAVIOUR".

NOTE 7: For "NETWORK_PERFORMANCE", "SERVICE_EXPERIENCE", "USER_DATA_CONGESTION" or "DN_PERFORMANCE" event, this attribute shall be provided if the event applied for all UEs (i.e. "anyUe" attribute set to true within the "tgtUe" attribute). For "QOS_SUSTAINABILITY", this attribute shall be provided.

NOTE 8: For "ABNORMAL_BEHAVIOUR" event with "anyUe" attribute in "tgtUe" attribute sets to true,

– at least one of the "networkArea" and the "snssais" attribute should be included, if the expected analytics type via the"exptAnaType" attribute or the list of Exception Ids via the "excepRequs" attribute is mobility related;

– at least one of the "networkArea", "appIds", "dnns" and "snssais" attribute should be included, if the expected analytics type via the"exptAnaType" attribute or the list of Exception Ids via the "excepRequs" attribute is communication related;

– the expected analytics type via the"exptAnaType" attribute or the list of Exception Ids via "excepRequs" attribute shall not be requested for both mobility and communication related analytics at the same time.

NOTE 9: If both the "allFreq" attribute and the "allRat" attribute are present within the RatFreqInformation data type, then only one instance of the RatFreqInformation data typeshall be present to indicate for all the RAT type and all the Frequency values the NWDAF has received for the application.

NOTE 10: If this attribute is provided, the analytics target period shall be a past time period (i.e. only statistics is supported).

NOTE 11: This parameter shall be provided when a consumer requires analytics for an edge application over a UP path.

NOTE 12: This parameter may be provided when a consumer requires analytics for an edge application over a UP path.

NOTE 13: When subscribed event is "NSI_LOAD_LEVEL" and the NsiLoadExt feature is supported, and the NF service consumer provides the "nfTypes" attribute, then the NWDAF accounts only for the resource usage of the NF types included in "nfTypes" to derive the output analytics. If the "nfTypes" attribute is not provided, then NWDAF accounts for the resource usage of all NF types.

eventNotifications

array(EventNotification)

C

1..N

Notifications about Individual Events.

(NOTE 1)

subscriptionId

string

M

1

String identifying a subscription to the Nnwdaf_EventsSubscription service. (NOTE 2)

notifCorrId

string

O

0..1

Notification correlation identifier.

EneNA

oldSubscriptionId

string

C

0..1

Subscription ID which was allocated by the source NWDAF.

This parameter shall be present if the notification is for informing the assignment of a new Subscription Id by the target NWDAF in the analytics transfer procedure.

(NOTE 1)

EneNA

resourceUri

Uri

C

1

The resource URI of the Individual NWDAF Event Subscription resource created by the target NWDAF.

Shall be present when the target NWDAF notifies a successful analytics subscription transfer.

(NOTE 1) (NOTE 2)

EneNA

termCause

TermCause

O

0..1

A cause for which the NWDAF will send no further notifications for this subscription. Its presence indicates that the NWDAF requests the termination of the subscription.

TermRequest

NOTE 1: Either "eventNotifications" attribute, or "resourceUri" and "oldSubscriptionId" attributes shall be provided.

NOTE 2: It shall be the same as the last segment of the “resourceUri” attribute when the target NWDAF notifies the consumer of the successful analytics subscription transfer.

event

NwdafEvent

M

1

Event that is notified.

start

DateTime

O

0..1

It defines the start time of which the analytics information will become valid. (NOTE 1)

expiry

DateTime

O

0..1

It defines the expiration time after which the analytics information will become invalid. (NOTE 1)

timeStampGen

DateTime

C

0..1

It defines the timestamp of analytics generation. (NOTE 3)

failNotifyCode

NwdafFailureCode

C

0..1

Identifies the failure reason for the event notification.

It shall only be included if the event notification is failed or the analytics information is not ready. (NOTE 2)

EneNA

rvWaitTime

DurationSec

O

0..1

Indicate a recommended time interval (in seconds) which is used to determine the time when analytics information is needed in similar future event subscriptions. It may only be included if the "failNotifyCode" attribute sets to "UNSATISFIED_REQUESTED_ANALYTICS_TIME".

EneNA

anaMetaInfo

AnalyticsMetadataInfo

C

0..1

Contains information about analytics metadata required to aggregate the analytics. It shall be present if the "anaMeta" attribute was included in the subscription, containing the information indicated by the "anaMeta" attribute.

Aggregation

nwPerfs

array(NetworkPerfInfo)

C

1..N

The network performance information.

Shall be present when subscribed even is "NETWORK_PERFORMANCE".

NetworkPerformance

nfLoadLevelInfos

array(NfLoadLevelInformation)

C

1..N

The NF load level information. When subscribed event is "NF_LOAD", the nfLoadLevelInfos shall be included.

NfLoad

nsiLoadLevelInfos

array(NsiLoadLevelInfo)

C

1..N

Each element identifies the load level information for each S-NSSAI and the optionally associated network slice instance.

Shall be included when subscribed event is "NSI_LOAD_LEVEL".

NsiLoad

qosSustainInfos

array(QosSustainabilityInfo)

C

1..N

The QoS sustainability information.

When subscribed event is "QOS_SUSTAINABILITY", the qosSustainInfos shall be included.

QoSSustainability

sliceLoadLevelInfo

SliceLoadLevelInformation

C

0..1

The slices and the load level information.

When subscribed event is "SLICE_LOAD_LEVEL", the sliceLoadLevelInfo shall be included.

svcExps

array(ServiceExperienceInfo)

C

1..N

The service experience information.

When subscribed event is "SERVICE_EXPERIENCE", the svcExps shall be included.

ServiceExperience

ueComms

array(UeCommunication)

C

1..N

The UE communication information.

When subscribed event is "UE_COMM", the ueComms shall be included.

UeCommunication

ueMobs

array(UeMobility)

C

1..N

The UE mobility information.

When subscribed event is "UE_MOBILITY", the ueMobs shall be included.

UeMobility

abnorBehavrs

array(AbnormalBehaviour)

C

1..N

The Abnormal Behaviour information.

When subscribed event is "ABNORMAL_BEHAVIOUR", the abnorBehavrs shall be included.

AbnormalBehaviour

userDataCongInfos

array(UserDataCongestionInfo)

C

1..N

The location and user data congestion information.

Shall be present if the subscribed event is "USER_DATA_CONGESTION".

UserDataCongestion

dnPerfInfos

array(DnPerfInfo)

C

1..N

The DN performance information.

Shall be present if the subscribed event is "DN_PERFORMANCE".

DnPerformance

disperInfos

array(DispersionInfo)

C

1..N

The Dispersion information.

When subscribed event is "DISPERSION", the "disperInfos" attribute shall be included.

Dispersion

redTransInfos

array(RedundantTransmissionExpInfo)

C

1..N

The redundant transmission experience related information.

When subscribed event is "RED_TRANS_EXP", the "redTransInfos" attribute shall be included.

RedundantTransmissionExp

wlanInfos

array(WlanPerformanceInfo)

C

1..N

The WLAN performance related information.

When subscribed event is "WLAN_PERFORMANCE", the "wlanInfos" attribute shall be included.

WlanPerformance

smccExps

array(SmcceInfo)

C

1..N

The Session Management Congestion Control Experience information.

Shall be present when the requested event is "SM_CONGESTION".

SMCCE

NOTE 1: If the "start" attribute and the "expiry" attribute are both provided, the DateTime of the "expiry" attribute shall not be earlier than the DateTime of the "start" attribute.

NOTE 2: The values of "UNAVAILABLE_DATA" and "BOTH_STAT_PRED_NOT_ALLOWED" of the NwdafFailureCode data type are not applicable for the "failNotifyCode" attribute.

NOTE 3: This attribute shall be included when ADRF is deployed.

loadLevelInformation

LoadLevelInformation

M

1

Load level information which applies for each network slice identified by snssais.

snssais

array(Snssai)

M

1..N

Identification(s) of network slice to which the subscription applies.

NOTE: If the requested period identified by the "startTs" and "endTs" attributes in the "EventReportingRequirement" type is a future time period, which means the analytics result is a prediction. If no sufficient data is collected to provide the confidence of the prediction before the time deadline, the NWDAF shall return a zero confidence.

accuracy

Accuracy

O

0..1

Preferred level of accuracy of the analytics. (NOTE 5)

accPerSubset

array(Accuracy)

O

1..N

Each element indicates the preferred accuracy level per analytics subset. It may be present if the "listOfAnaSubsets" attribute is present in the subscription request when the subscription event is NF_LOAD, UE_COMM, DISPERSION, NETWORK_PERFORMANCE, WLAN_PERFORMANCE, DN_PERFORMANCE or SERVICE_EXPERIENCE. (NOTE 4, NOTE 5)

EneNA

startTs

DateTime

O

0..1

UTC time indicating the start time of the observation period.

The absence of this attribute means subscription at the present time unless the "offsetPeriod" attribute is included. (NOTE 3)

endTs

DateTime

O

0..1

UTC time indicating the end time of the observation period.

If the start time is in the past, then the absence of this attribute means that the end time of the subscription is at the present time, unless the "offsetPeriod" attribute is included.

If provided, it shall not be less than the start time. (NOTE 3)

offsetPeriod

integer

O

0..1

Offset period in units of seconds to the reporting time, if the value is negative means statistics in the past offset period, otherwise a positive value means prediction in the future offset period. May be present if the "repPeriod" attribute is included within the "evtReq" attribute. (NOTE 3)

EneNA

sampRatio

SamplingRatio

O

0..1

Percentage of sampling (1%…100%) among impacted UEs.

Applicable to event targeting a group of UEs or any UE.

(NOTE 1)

maxSupiNbr

Uinteger

O

0..1

Represents the maximum number of SUPIs expected in an object.

Applicable for the event(s) providing a list of SUPIs during the analytics response.

maxObjectNbr

Uinteger

O

0..1

Maximum number of objects expected for an analytics report. It’s only applicable for the event(s) which may provide more than one entries or objects during event notification.

timeAnaNeeded

DateTime

O

0..1

UTC time indicating the time when analytcs information is needed.

EneNA

anaMeta

array(AnalyticsMetadata)

O

1..N

List of analytics metadata that are requested to be included.

Aggregation

anaMetaInd

AnalyticsMetadataIndication

O

0..1

Contains values for the analytics metadata that the NF service consumer wants to be used for generating the analytics.

Aggregation

NOTE 1: The "sampRatio" attribute within EventReportingRequirement data type is not applicable for the Nnwdaf_EventsSubscription API.

NOTE 2: Void.

NOTE 3: When the "offsetPeriod" attribute is included, the "startTs" and "endTs" attributes shall not be included. If the analytics target period is indicated either by providing a "startTs" attribute and an "endTs" attribute that are equal, or by providing an "offsetPeriod" attribute equal to zero (which means there is no offset to the periodic reporting time indicated by the "repPeriod" attribute), then this is a request for analytics for a specific time of the same "startTs" attribute and "endTs" attribute or each specific time periodically indicated by the "repPeriod" attribute , rather than for a time interval. If none of the attributes "startTs", "endTs" and "offsetPeriod" is provided, the analytics target period starts at the present time and there is no specified end time.

NOTE 4: If multiple accuracy entries are included, the order of the entries of the "accPerSubset" attribute corresponds with the order of the entries of the "listOfAnaSubsets" attribute, i.e. the first entry of the "accPerSubset" attribute holds the requested accuracy for the analytics subset that is indicated by the first entry of the "listOfAnaSubsets" attribute, and so on.

NOTE 5: If both the "accuracy" attribute and "accPerSubset" attribute were provided in the request, the "accPerSubset" attribute takes precedence over the "accuracy" attribute.

anyUe

boolean

O

0..1

Identifies any UE when setting to true. (NOTE 3)

ServiceExperience

NetworkPerformance

NfLoad

UserDataCongestion

AbnormalBehaviour

QoSSustainability

Dispersion

RedundantTransmissionExp

WlanPerformance

DnPerformance

supis

array(Supi)

O

1..N

Each element represents a SUPI for a UE.

(NOTE 2)

UeMobility

UeCommunication

NetworkPerformance

AbnormalBehaviour

UserDataCongestion

NfLoad

ServiceExperience

Dispersion

RedundantTransmissionExp

WlanPerformance

SMCCE

DnPerformance

gpsis

array(Gpsi)

O

1..N

Each element represents a GPSI for a UE.

(NOTE 2)

UserDataCongestionExt

DnPerformance

intGroupIds

array(GroupId)

O

1..N

Each element represents an internal group identifier and identifies a group of UEs.

(NOTE 2)

UeMobility

UeCommunication

NetworkPerformance

AbnormalBehaviour

ServiceExperience

Dispersion

RedundantTransmissionExp

WlanPerformance

DnPerformance

NOTE 1: For an applicable feature or UserDataCongestion and UserDataCongestionExt features are both applicable, only one attribute identifying the target UE shall be provided.

NOTE 2: Only one element in the attribute shall be provided for the applicable events except the "SERVICE_EXPERIENCE" event, the "DISPERSION" event and/or the "SMCCE" event.

NOTE 3: For feature "Dispersion", any UE is only supported in combination with S-NSSAI, Area of Interest and/or Dispersion Class.

ts

DateTime

C

0..1

This attribute identifies the timestamp when the UE arrives the location. (NOTE 1)

recurringTime

ScheduledCommunicationTime

C

0..1

Identifies time of the day and day of the week which are valid within the observation period when the UE moves. (NOTE 1, NOTE 2)

duration

DurationSec

M

1

This attribute identifies the time duration the UE stays in the location.

If the analytics result applies for a group of UEs, it indicates the average duration for the group of UEs.

durationVariance

Float

C

0..1

This attribute indicates the variance of the analysed durations for the group of UEs. It shall be provided if the analytics result applies for a group of UEs.

locInfos

array(LocationInfo)

M

1..N

This attribute includes a list of UE location information during the time duration.

NOTE 1: Either "ts" or "recurringTime" shall be provided.

NOTE 2: If this attribute is present, it indicates the UE movement is periodic. This attribute is suitable to be present for a recurring mobility in a long observation time.

loc

UserLocation

M

1

This attribute contains the detailed location, the ueLocationTimestamp attribute in the 3GPP access type of UserLocation data type shall not be provided.

ratio

SamplingRatio

C

0..1

This attribute contains the percentage of UEs with same analytics result in the group.

Shall be present if the analytics result applies for a group of UEs.

confidence

Uinteger

C

0..1

Indicates the confidence of the prediction. (NOTE)

Shall be present if the analytics result is a prediction.

Minimum = 0. Maximum = 100.

NOTE: If the requested period identified by the "startTs" and "endTs" attributes in the "EventReportingRequirement" type is a future time period, which means the analytics result is a prediction. If no sufficient data is collected to provide the confidence of the prediction before the time deadline, the NWDAF shall return a zero confidence.

commDur

DurationSec

M

1

Identifies the duration of the communication.

If the analytics result applies for a group of UEs, it indicates the average duration for the subset of UEs indicated by a given ratio in the group.

commDurVariance

Float

C

0..1

This attribute indicates the variance of the analysed durations for the subset of UEs indicated by a given ratio in the group. It shall be provided if the analytics result applies for a group of UEs.

perioTime

DurationSec

O

0..1

Identifies interval time of periodic communication, e.g. every 10 minutes or 1 hour. (NOTE 2)

If the analytics result applies for a group of UEs, it indicates the average interval time of periodic communication for the subset of UEs indicated by a given ratio in the group.

perioTimeVariance

Float

C

0..1

This attribute indicates the variance of the analysed intervals of periodic communication for the subset of UEs indicated by a given ratio in the group. It shall be provided if the analytics result applies for a group of UEs.

ts

DateTime

C

0..1

Identifies the start time of the communication. (NOTE 1)

tsVariance

Float

O

0..1

This attribute indicates the variance of the analysed start time for the subset of UEs indicated by a given ratio in the group. It may only be provided if the ts attribute is provided.

recurringTime

ScheduledCommunicationTime

C

0..1

Identifies time of the day and day of the week which are valid within the observation period when the UE has communication. Providing the end time in ScheduledCommunicationTime data type is not required. (NOTE 1, NOTE 3)

trafChar

TrafficCharacterization

M

1

Identifies the detailed traffic characterization.

ratio

SamplingRatio

C

0..1

This attribute contains the percentage of UEs with same analytics result in the group.

Shall be present if the analytics result applies for a group of UEs.

perioCommInd

boolean

O

0..1

This attribute indicates whether the UE communicates periodically or not.

UeCommunicationExt

confidence

Uinteger

C

0..1

Indicates the confidence of the prediction. (NOTE 4)

Shall be present if the analytics result is a prediction.

Minimum = 0. Maximum = 100.

anaOfAppList

AppListForUeComm

C

0..1

Represents the analytics of the application list used by UE.

Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set to APP_LIST_FOR_UE_COMM.

UeCommunicationExt

sessInactTimer

SessInactTimerForUeComm

C

0..1

Represents the N4 Session inactivity timer.

Shall be present only if one of the elements in the "listOfAnaSubsets" attribute was set to N4_SESS_INACT_TIMER_FOR_UE_COMM and the identified NF service consumer is an SMF. (NOTE 5)

UeCommunicationExt

NOTE 1: Either "ts" or "recurringTime" shall be provided.

NOTE 2: If this attribute is present, it indicates the communication is periodic and its value shall be larger than the commDur value. If this attribute is present with the ts attribute, it indicates the periodic communication time valid within the observation period; if it is present with the recurringTime attribute, it indicates the periodic communication time valid within the day(s).

NOTE 3: If this attribute is present, it indicates the communication is periodic. This attribute is suitable to be present for a recurring communication in a long observation time.

NOTE 4: If the requested period identified by the "startTs" and "endTs" attributes in the EventReportingRequirement type is a future time period, which means the analytics result is a prediction. If no sufficient data is collected to provide the confidence of the prediction before the time deadline, the NWDAF shall return a zero confidence.

NOTE 5: This attribute shall not be provided if the NWDAF does not know the NF service consumer type or if the NWDAF knows that the NF service consumer is not an SMF.

appId

ApplicationId

O

0..1

Contains the application identifier.

dnn

Dnn

O

0..1

Identifies DNN, a full DNN with both the Network Identifier and Operator Identifier, or a DNN with the Network Identifier only.

Shall be present if the "dnns" was provided within EventSubscription during the subscription for event notification procedure.

snssai

Snssai

C

0..1

Identifies the network slice.

Shall be present if the "snssais" was provided within EventSubscription during the subscription for event notification procedure.

fDescs

array(IpEthFlowDescription)

O

1..2

Contains the flow description for the Uplink and/or Downlink flows.

ulVol

Volume

C

0..1

Identifies the uplink traffic volume. (NOTE)

If the analytics result applies for a group of UEs, it indicates the average uplink traffic volume for the subset of UEs indicated by a given ratio in the group.

ulVolVariance

Float

C

0..1

This attribute indicates the variance of the uplink traffic volumes for the subset of UEs indicated by a given ratio in the group. It shall be provided if the analytics result applies for a group of UEs.

dlVol

Volume

C

0..1

Identifies the downlink traffic volume. (NOTE)

If the analytics result applies for a group of UEs, it indicates the average downlink traffic volume for the subset of UEs indicated by a given ratio in the group.

dlVolVariance

Float

C

0..1

This attribute indicates the variance of the downlink traffic volumes for the subset of UEs indicated by a given ratio in the group. It shall be provided if the analytics result applies for a group of UEs.

NOTE: At least one of "ulVol" or "dlVol" shall be provided.

supis

array(Supi)

C

1..N

Each element identifies a UE which is affected with the Exception.

Shall be present if the subscription request applies to more than one UE.

dnn

Dnn

C

0..1

Identifies DNN, a full DNN with both the Network Identifier and Operator Identifier, or a DNN with the Network Identifier only.

Shall be present if the "dnns" was provided within EventSubscription during the subscription for event notification procedure.

excep

Exception

M

1

Contains the exception information.

snssai

Snssai

C

0..1

Identifies the network slice information.

Shall be present if the "snssais" was provided within EventSubscription during the subscription for event notification procedure.

ratio

SamplingRatio

C

0..1

Contains the percentage of UEs with same analytics result in the group or among all UEs.

Shall be present if the analytics result applies for a group of UEs or any UE.

confidence

Uinteger

C

0..1

Indicates the confidence of the prediction. (NOTE)

Shall be present if the analytics result is a prediction.

Minimum = 0. Maximum = 100.

addtMeasInfo

AdditionalMeasurement

O

0..1

Additional measurement.

NOTE: If the requested period identified by the "startTs" and "endTs" attributes in the "EventReportingRequirement" type is a future time period, which means the analytics result is a prediction. If no sufficient data is collected to provide the confidence of the prediction before the time deadline, the NWDAF shall return a zero confidence.

excepId

ExceptionId

M

1

Indicating the Exception ID.

excepLevel

integer

O

0..1

Measured level, compared to the threshold

excepTrend

ExceptionTrend

O

0..1

Measured trend

networkArea

NetworkAreaInfo

M

1

Identification of network area to which the subscription applies.

congestionInfo

CongestionInfo

M

1

The congestion information of the specific location.

snssai

Snssai

C

0..1

Identifies an S-NSSAI.

Shall be present if the "snssais" was provided within EventSubscription during the subscription for event notification procedure.

congType

CongestionType

M

1

Identification congestion analytics type.

timeIntev

TimeWindow

M

1

Represents the start time and the stop time to which requested for the congestion information applies.

nsi

ThresholdLevel

M

1

Network Status Indication.

confidence

Uinteger

C

0..1

Indicates the confidence of the prediction. (NOTE)

Shall be present if the analytics result is a prediction.

Minimum = 0. Maximum = 100.

topAppListUl

array(TopApplication)

C

1..N

List of top applications in Uplink. Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set to LIST_OF_TOP_APP_UL.

UserDataCongestionExt

topAppListDl

array(TopApplication)

C

1..N

List of top applications in Downlink. Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set to LIST_OF_TOP_APP_DL.

UserDataCongestionExt

NOTE: If the requested period identified by the "startTs" and "endTs" attributes in the EventReportingRequirement type is a future time period, which means the analytics result is a prediction. If no sufficient data is collected to provide the confidence of the prediction before the time deadline, the NWDAF shall return a zero confidence.

areaInfo

NetworkAreaInfo

M

1

Identification(s) of applicable location areas to which the subscription.

startTs

DateTime

M

1

Represents the start time of the applicable observing period.

endTs

DateTime

M

1

Represents the end time of the applicable observing period.

qosFlowRetThd

RetainabilityThreshold

C

0..1

The reporting QoS Flow Retainability Threshold that are met or crossed for 5QI of GBR resource type.

(NOTE 1)

ranUeThrouThd

BitRate

C

0..1

The reporting RAN UE Throughput Threshold that are met or crossed for 5QI of non-GBR resource type.

(NOTE 1)

snssai

Snssai

C

0..1

Identifies an S-NSSAI.

Shall be present if the "snssais" was provided within EventSubscription during the subscription for event notification procedure.

confidence

Uinteger

C

0..1

Indicates the confidence of the prediction. (NOTE 2)

Shall be present if the analytics result is a prediction.

Minimum = 0. Maximum = 100.

NOTE 1: Either "qosFlowRetThd" or "ranUeThrouThd" attribute shall be provided.

NOTE 2: If the requested period identified by the "startTs" and "endTs" attributes in the EventReportingRequirement type is a future time period, which means the analytics result is a prediction. If no sufficient data is collected to provide the confidence of the prediction before the time deadline, the NWDAF shall return a zero confidence.

5qi

5Qi

C

0..1

Represents a 5G QoS Identifier. It shall be included for standardized or preconfigured 5QIs. (NOTE)

gfbrUl

BitRate

C

0..1

Indicates GFBR in the uplink.

It shall be included for GBR 5QIs.

gfbrDl

BitRate

C

0..1

Indicates GFBR in the downlink.

It shall be included for GBR 5QIs.

resType

QosResourceType

C

0..1

Resource type.

Shall be provided for the non-standardized and non-preconfigured QoS characteristics. (NOTE)

pdb

PacketDelBudget

O

0..1

Packet Delay Budget.

May be supplied for the non-standardized and non-pre-configured QoS characteristics.

per

PacketErrRate

O

0..1

Packet Error Rate.

May be supplied for the non-standardized and non-pre-configured QoS characteristics.

NOTE: Either 5QI within "5qi" attribute or the resource type within "resType" attribute shall be provided.

relFlowNum

Uinteger

C

0..1

Represents the number of abnormally released QoS flows. (NOTE)

relTimeUnit

TimeUnit

C

0..1

Represents the unit for the session active time, shall be present if relFlowNum is present. (NOTE)

relFlowRatio

SamplingRatio

C

0..1

Represents the ratio of abnormally released QoS flows to the total released QoS flows, expressed in percentage. (NOTE)

NOTE: Either "relFlowNum" and its associated "relTimeUnit" attributes or "relFlowRatio" attributes shall be provided. The "relFlowNum" and "relTimeUnit" attributes together represents the number of abnormally released QoS flows (i.e. relFlowNum) within the time unit (i.e. relTimeUnit).

nwPerfType

NetworkPerfType

M

1

The type of the network performance.

relativeRatio

SamplingRatio

C

0..1

The relative ratio expressed in percentage. (NOTE)

absoluteNum

Uinteger

C

0..1

The absolute number (NOTE)

NOTE: Either "relativeRatio" or "absoluteNum" shall be provided if the "notifMethod" in "evtReq" is set to "ON_EVENT_DETECTION" or "notificationMethod" in "eventSubscriptions" is set to "THRESHOLD" or omitted.

networkArea

NetworkAreaInfo

M

1

Identification of network area to which the subscription applies.

nwPerfType

NetworkPerfType

M

1

The type of the network performance

relativeRatio

SamplingRatio

C

0..1

The reported relative ratio expressed in percentage. (NOTE 1)

absoluteNum

Uinteger

C

0..1

The reported absolute number (NOTE 1)

confidence

Uinteger

C

0..1

Indicates the confidence of the prediction. (NOTE 2)

Shall be present if the analytics result is a prediction.

Minimum = 0. Maximum = 100.

NOTE 1: Either "relativeRatio" or "absoluteNum" shall be provided.

NOTE 2: If the requested period identified by the "startTs" and "endTs" attributes in the EventReportingRequirement type is a future time period, which means the analytics result is a prediction. If no sufficient data is collected to provide the confidence of the prediction before the time deadline, the NWDAF shall return a zero confidence.

svcExprc

SvcExperience

M

1

Service experience

svcExprcVariance

Float

O

0..1

This attribute indicates the variance .

supis

array(Supi)

O

1..N

Each element identifies a UE.

May only be present if the subscription request applies to more than one UE. (NOTE 3)

snssai

Snssai

C

0..1

Identifies an S-NSSAI.

Shall be presented if the "snssais" was provided within EventSubscription during the subscription for event notification procedure.

appId

ApplicationId

C

0..1

Identifies an application.

Shall be present if the "appIds" was provided within EventSubscription during the subscription for event notification procedure.

srvExpcType

ServiceExperienceType

O

0..1

Indicates the type of Service Experience analytics.

ServiceExperienceExt

ueLocs

array(LocationInfo)

C

1..N

This attribute includes a list of UE location information during the time duration.

Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set to UE_LOCATION.

(NOTE 2)

ServiceExperienceExt

upfInfo

UpfInformation

C

0..1

Represents the information of the UPF serving the UE.

Shall be present only if the "upfInfo" attribute was provided in the request or subscription and the NF service consumer is identified as not an AF or a NEF. (NOTE 4)

ServiceExperienceExt

dnai

Dnai

C

0..1

Indicates the DN Access Identifier representing location of the service flow. Shall be present if the "dnais" attribute was provided in the request or subscription.

ServiceExperienceExt

appServerInst

AddrFqdn

C

0..1

Represents the Application Server Instance (IP address or FQDN of the Application Server).

Shall be present if the "appServerAddrs" attribute was provided in the request or subscription.

ServiceExperienceExt

confidence

Uinteger

C

0..1

Indicates the confidence of the prediction. (NOTE 1)

Shall be present if the analytics result is a prediction.

Minimum = 0. Maximum = 100.

dnn

Dnn

C

0..1

Identifies DNN, a full DNN with both the Network Identifier and Operator Identifier, or a DNN with the Network Identifier only.

Shall be present if the "dnns" was provided within EventSubscription during the subscription for event notification procedure.

networkArea

NetworkAreaInfo

C

0..1

Identifies the network area where the service experience applies. Shall be presented if the "networkArea" was provided within EventSubscription during the subscription for event notification procedure.

nsiId

NsiId

C

0..1

Identifies a network slice instance which is associated with the S-NSSAI identified by the "snssai" attribute.

Shall be presented if the "nsiIds" was provided within the NsiIdInfo data in the EventSubscription data during the subscription.

ratio

SamplingRatio

C

0..1

Contains the percentage of UEs with same analytics result in the group or among all UEs.

Shall be present if the analytics result applies for a group of UEs or any UE. (NOTE 3)

ratFreq

RatFreqInformation

C

0..1

Identification of the RAT type(s) and/or frequency(ies) of UE’s serving cell(s) which the subscription/request applies.

Shall be present if the "ratFreqs" was provided in the EventSubscription data during the subscription.

When "allRat" and/or "allFreq" are included in the subscription, the NWDAF provides an instance of the Application service experience per combination of RAT Type(s) and/or Frequency value(s) having the same Service Experience.

ServiceExperienceExt

NOTE 1: If the requested period identified by the "startTs" and "endTs" attributes in the "EventReportingRequirement" type is a future time period, which means the analytics result is a prediction. If no sufficient data is collected to provide the confidence of the prediction before the time deadline, the NWDAF shall return a zero confidence.

NOTE 2: The "ueLocs" attribute shall only be included if the consumer analytics request is for a single UE or a list of UEs. Inclusion of such UE location requires user consent during the UE location data collection.

NOTE 3: The SUPI list and Ratio in the service experience information for an application may be omitted if the reported service experience information is provided and is assigned with the same value(s) for the slice instance which the application belongs to. Otherwise, the SUPI list and Ratio shall be provided for an application service experience.

NOTE 4: This attribute shall not be provided if the NWDAF does not know the NF service consumer type or if the NWDAF knows that the NF service consumer is an AF or a NEF.

appId

ApplicationId

M

1

Represents an application.

(NOTE)

marBwUl

BitRate

O

0..1

Maximum requested bandwidth for the Uplink.

marBwDl

BitRate

O

0..1

Maximum requested bandwidth for the Downlink.

mirBwUl

BitRate

O

0..1

Minimum requested bandwidth for the Uplink.

mirBwDl

BitRate

O

0..1

Minimum requested bandwidth for the Downlink.

NOTE: If the "appIds" attribute is provided within EventSubscription data, this attribute shall be indicated by the "appIds" attribute.

unexpLoc

NetworkAreaInfo

C

0..1

The unexpected locations which the UE stays.

It may only be present when the "excepId" within the Exception data sets to "UNEXPECTED_UE_LOCATION"

unexpFlowTeps

array(IpEthFlowDescription)

C

1..N

Unexpected IP or Ethernet flow templates.

It may only be present when the "excepId" within the Exception data sets to "UNEXPECTED_LONG_LIVE_FLOW" or "UNEXPECTED_LARGE_RATE_FLOW".

unexpWakes

array(DateTime)

C

1..N

Unexpected wake up times.

It may only be present when the "excepId" within the Exception data sets to "UNEXPECTED_WAKEUP".

ddosAttack

AddressList

C

0..1

Victim’s address list.

It may only be present when the "excepId" within the Exception data sets to "SUSPICION_OF_DDOS_ATTACK".

wrgDest

AddressList

C

0..1

Wrong destination address list.

It may only be present when the "excepId" within the Exception data sets to "WRONG_DESTINATION_ADDRESS".

circums

array(CircumstanceDescription)

C

1..N

The description of circumstances.

It may only be present when the "excepId" within the Exception data sets to "TOO_FREQUENT_SERVICE_ACCESS", "UNEXPECTED_RADIO_LINK_FAILURES" or "PING_PONG_ACROSS_CELLS".

ipTrafficFilter

FlowDescription

C

0..1

Identifies IP packet filter.(NOTE)

ethTrafficFilter

EthFlowDescription

C

0..1

Identifies Ethernet packet filter.(NOTE)

NOTE: Either "ipTrafficFilter" or "ethTrafficFilter" shall be provided.

ipv4Addrs

array(Ipv4Addr)

O

1..N

Each element identifies an IPv4 address.

ipv6Addrs

array(Ipv6Addr)

O

1..N

Each element identifies an IPv6 address.

NOTE: At least one of "ipv4Addrs" or "ipv6Addrs" shall be provided.

freq

Float

O

0..1

Communication frequency of the UE in units of MHz.

tm

DateTime

O

0..1

Time when UE enters the location.

locArea

NetworkAreaInfo

C

0..1

The location of the UE.

It shall be present when the "excepId" within the Exception data sets to "UNEXPECTED_RADIO_LINK_FAILURES" or "PING_PONG_ACROSS_CELLS".

vol

Volume

C

0..1

The traffic volume.

It shall be present when the "excepId" within the Exception data sets to "TOO_FREQUENT_SERVICE_ACCESS" or "UNEXPECTED_LARGE_RATE_FLOW ".

congLevel

integer

C

0..1

Value of Congestion that triggers notification (NOTE 1)

UserDataCongestion

nfLoadLevel

integer

C

0..1

Value of NF Load that triggers notification (NOTE 2)

Minimum = 0. Maximum = 100.

NfLoad

nfCpuUsage

integer

C

0..1

Value of NF CPU Usage that triggers notification (NOTE 2)

Minimum = 0. Maximum = 100.

NfLoad

nfMemoryUsage

integer

C

0..1

Average usage of memory (NOTE 2)

Minimum = 0. Maximum = 100.

NfLoad

nfStorageUsage

integer

C

0..1

Average usage of storage (NOTE 2)

Minimum = 0. Maximum = 100.

NfLoad

avgTrafficRate

BitRate

C

0..1

Threshold level of average traffic rate.

Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set to AVG_TRAFFIC_RATE.

(NOTE 3)

DnPerformance

maxTrafficRate

BitRate

C

0..1

Threshold level of maximum traffic rate.

Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set to MAX_TRAFFIC_RATE.

(NOTE 3)

DnPerformance

avgPacketDelay

PacketDelBudget

C

0..1

Threshold level of average Packet Delay.

Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set to AVG_PACKET_DELAY.

(NOTE 3)

DnPerformance

maxPacketDelay

PacketDelBudget

C

0..1

Threshold level of maximum Packet Delay.

Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set to MAX_PACKET_DELAY.

(NOTE 3)

DnPerformance

avgPacketLossRate

PacketLossRate

C

0..1

Threshold level of average Loss Rate.

Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set to AVG_PACKET_LOSS_RATE.

(NOTE 3)

DnPerformance

svcExpLevel

float

C

0..1

Service Experience MOS value. Shall be present when subscribed event is "SERVICE_EXPERIENCE".

ServiceExperienceExt

NOTE 1: This attribute shall be provided when subscribed event is "USER_DATA_CONGESTION".

NOTE 2: At least one attribute should be provided when subscribed event is "NF_LOAD".

NOTE 3: At least one attribute should be provided when subscribed event is "DN_PERFORMANCE".

nfType

NFType

M

1

Type of the NF instance

nfInstanceId

NfInstanceId

M

1

Identification of the NF instance

nfSetId

NfSetId

O

0..1

Identification of the NF instance set

nfStatus

NfStatus

C

0..1

Availability status of the NF (NOTE 1)

nfCpuUsage

integer

C

0..1

Average usage CPU (NOTE 1, NOTE 2)

Minimum = 0. Maximum = 100.

nfMemoryUsage

integer

C

0..1

Average usage of memory (NOTE 1, NOTE 2)

Minimum = 0. Maximum = 100.

nfStorageUsage

integer

C

0..1

Average usage of storage (NOTE 1, NOTE 2)

Minimum = 0. Maximum = 100.

nfLoadLevelAverage

integer

C

0..1

Average load information (NOTE 1, NOTE 2)

Minimum = 0. Maximum = 100.

nfLoadLevelPeak

integer

C

0..1

Peak load information (NOTE 1, NOTE 2)

Minimum = 0. Maximum = 100.

nfLoadAvgInAoi

integer

C

0..1

The average load of the NF instances over the area of interest. (NOTE 1, NOTE 2, NOTE 4)

Minimum = 0. Maximum = 100.

NfLoadExt

snssai

Snssai

C

0..1

Identifies an S-NSSAI.

Shall be present if the "snssais" was provided within EventSubscription during the subscription for event notification procedure.

confidence

Uinteger

C

0..1

Indicates the confidence of the prediction. (NOTE 3)

Shall be present if the analytics result is a prediction.

Minimum = 0. Maximum = 100.

NOTE 1: At least one value shall be provided. If the "listofAnaSubsets" attribute with value only applicable to NF_LOAD event is present in the subscription request, then only the corresponding attribute(s) shall be present.

NOTE 2: The values are percentages which are provided as estimated over a given period.

NOTE 3: If the requested period identified by the "startTs" and "endTs" attributes in the EventReportingRequirement type is a future time period, which means the analytics result is a prediction. If no sufficient data is collected to provide the confidence of the prediction before the time deadline, the NWDAF shall return a zero confidence.

NOTE 4: Applicable only to AMF load If the "networkArea" attribute is present in the subscription request.

statusRegistered

SamplingRatio

C

0..1

Percentage of time with status "registered" (NOTE)

statusUnregistered

SamplingRatio

C

0..1

Percentage of time with status "unregistered" (NOTE)

statusUndiscoverable

SamplingRatio

C

0..1

Percentage of time with status "undiscoverable" (NOTE)

NOTE: The availability statuses of the NF on the Analytics target period are expressed as a percentage of time. The total of status values should be equal or lower than 100%. At least one value shall be provided.

snssai

Snssai

M

1

Identification of network slice to which the subscription for event notification procedure applies.

nsiIds

array(NsiId)

O

1..N

Identification of network slice instance(s) associated with the subscribed S-NSSAI identified by the "snssai" attribute.

May be included when subscribed event is "NSI_LOAD_LEVEL" or

"SERVICE_EXPERIENCE".

(NOTE)

NOTE: This attribute is not applicable when the NF service consumer is CEF or PCF.

loadLevelInformation

LoadLevelInformation

M

1

Load level information of the network slice identified by the "snssai" attribute and if provided, the associated NSI ID identified by the "nsiId" attribute.

snssai

Snssai

M

1

Identification of network slice to which the subscription applies.

nsiId

NsiId

C

0..1

Identification of network slice instance associated with the S-NSSAI identified by the "snssai" attribute.

Shall be presented if the "nsiIds" attribute was provided within the NsiIdInfo data in the EventSubscription data during the subscription.

resUsage

ResourceUsage

C

0..1

The current usage of the virtual resources assigned to the NF instances belonging to a particular network slice instance.

Shall be present if one of the element in the "listOfAnaSubsets" attribute was set to RES_USAGE.

NsiLoadExt

numOfExceedLoadLevelThr

integer

C

0..1

Indicates the number of times the resource usage threshold of the network slice instance is reached or exceeded if a threshold value is provided by the consumer.

Shall be present if one of the element in the "listOfAnaSubsets" attribute was set to NUM_OF_EXCEED_RES_USAGE_LOAD_LEVEL_THR.

NsiLoadExt

exceedLoadLevelThrInd

boolean

C

0..1

Indicates whether the Load Level Threshold is met or exceeded by the statistics value. Set to "true" if the Load Level Threshold is met or exceeded, otherwise set to "false".

Shall be present if one of the element in the "listOfAnaSubsets" attribute was set to EXCEED_LOAD_LEVEL_THR_IND.

NsiLoadExt

networkArea

NetworkAreaInfo

O

0..1

Identification of network area to which the subscription or analytics request applies.

NsiLoadExt

timePeriod

TimeWindow

O

0..1

Indicates a start time and a stop time of the load level information identified by the "loadLevelInformation" attribute.

NsiLoadExt

resUsgThrCrossTimePeriod

array(TimeWindow)

O

1..N

Each element indicates the time elapsed between times each threshold is met or exceeded or crossed. The start time and end time are the exact time stamps of the resource usage threshold is reached or exceeded. May be present if the "listOfAnaSubsets" attribute is provided and the maximum number of instances shall not exceed the value provided in the "numOfExceedLoadLevelThr" attribute.

NsiLoadExt

numOfUes

NumberAverage

C

0..1

Indicates the average and variance number of UE registered at the S-NSSAI and the optionally associated network slice instance.

Shall be present if one of the element in the "listOfAnaSubsets" attribute was set to NUM_OF_UE_REG.

NsiLoadExt

numOfPduSess

NumberAverage

C

0..1

Indicates the average and variance number of PDU session established at the S-NSSAI and the optionally associated network slice instance.

Shall be present if one of the element in the "listOfAnaSubsets" attribute was set to NUM_OF_PDU_SESS_ESTBL.

NsiLoadExt

confidence

Uinteger

C

0..1

Indicates the confidence of the prediction. (NOTE)

Shall be present if the analytics result is a prediction.

Minimum = 0. Maximum = 100.

NsiLoadExt

NOTE: If the requested period identified by the "startTs" and "endTs" attributes in the "EventReportingRequirement" type is a future time period, which means the analytics result is a prediction. If no sufficient data is collected to provide the confidence of the prediction before the time deadline, the NWDAF shall return a zero confidence.

event

NwdafEvent

M

1

Event that is subscribed.

failureCode

NwdafFailureCode

M

1

Identifies the failure reason

dataWindow

TimeWindow

O

0..1

Data time window of the data samples.

dataStatProps

array(DatasetStatisticalProperty)

O

1..N

List of dataset statistical properties of the data to be used to generate the analytics.

strategy

OutputStrategy

O

0..1

Output strategy to be used for the reporting of the analytics.

aggrNwdafIds

array(NfInstanceId)

O

1..N

NWDAF identifiers of NWDAF instances used by the NWDAF service consumer when aggregating multiple analytics subscriptions.

numSamples

Uinteger

O

0..1

Number of data samples used for the generation of the output analytics.

dataWindow

TimeWindow

O

0..1

Data time window of the data samples.

dataStatProps

array(DatasetStatisticalProperty)

O

1..N

List of dataset statistical properties of the data used to generate the analytics.

strategy

OutputStrategy

O

0..1

Output strategy used for the reporting of the analytics.

accuracy

Accuracy

O

0..1

Level of accuracy reached for the analytics.

number

Float

M

1

The average number.

variance

Float

M

1

Identifies the variance.

skewness

Float

O

0..1

Contains the skewness.

appId

ApplicationId

C

0..1

Indicates an application identifier.

(NOTE)

ipTrafficFilter

FlowInfo

C

0..1

Identifies IP packet filter. (NOTE)

ratio

SamplingRatio

O

0..1

The application’s throughput as a percentage of the total throughput in the Area of Interest.

NOTE: Either "appId" or "ipTrafficFilter" shall be provided.

subsTransInfos

array(SubscriptionTransferInfo)

M

1..N

Contains information about the subscription(s) that are requested to be transferred.

transReqType

TransferRequestType

M

1

Indicates the type of the transfer request (i.e. if it is a request for transfer preparation or transfer execution)

nwdafEvSub

NnwdafEventsSubscription

M

1

Contains information about the analytics subscription that is to be transferred. (NOTE)

consumerId

NfInstanceId

M

1

NF instance identifer of the consumer of the analytics subscription that is to be transferred.

contextId

AnalyticsContextIdentifier

O

0..1

Identifier of analytics context information available at the NF service consumer.

sourceNfIds

array(NfInstanceId)

O

1..N

NF instance identifer(s) of active data source(s) the NF service consumer is currently using for the analytics of the subscription that is to be transferred.

sourceSetIds

array(NfSetId)

O

1..N

NF set identifer(s) of active data source(s) the NF service consumer is currently using for the analytics of the subscription that is to be transferred.

modelInfos

array(ModelInfo)

O

1..N

Contains information identifying the ML model(s) that the NF service consumer is currently using for the analytics.

NOTE: The "nwdafEvSub" attribute shall contain the "notificationURI" attribute.

analyticsId

NwdafEvent

M

1

Type of analytics for which this ML model is used.

mlModelInfos

array(MLModelInfo)

M

1..N

The information of the ML models which are applicable to the event indicated by "analyticsId" attribute.

subscriptionId

string

M

1

Identifies a subscription to the Nnwdaf_EventsSubscription Service.

nfAnaCtxts

array(NwdafEvent)

O

1..N

List of analytics types for which NF related analytics contexts can be retrieved. (NOTE)

ueAnaCtxts

array(UeAnalyticsContextDescriptor)

O

1..N

List of objects that indicate for which SUPI and analytics types combinations analytics context can be retrieved. (NOTE)

NOTE: At least one of "nfAnaCtxts" and "ueAnaCtxts" shall be provided.

supi

Supi

M

1

SUPI of the UE for which analytics context can be retrieved.

anaTypes

array(NwdafEvent)

M

1..N

List of analytics types for which UE related analytics contexts can be retrieved.

appId

ApplicationId

C

0..1

Indicates an application identifier. Shall be present if the "appIds" attribute was provided in the request or subscription.

dnn

Dnn

C

0..1

Identifies DNN, a full DNN with both the Network Identifier and Operator Identifier, or a DNN with the Network Identifier only.

Shall be present if the "dnns" was provided in the request or subscription.

snssai

Snssai

C

0..1

Identifies the network slice information.

Shall be present if the "snssais" was provided in the request or subscription.

dnPerf

array(DnPerf)

M

1..N

List of DN performances for the application.

confidence

Uinteger

C

0..1

Indicates the confidence of the prediction. (NOTE 1)

Shall be present if the analytics result is a prediction.

Minimum = 0. Maximum = 100.

NOTE 1: If the requested period identified by the "startTs" and "endTs" attributes in the "EventReportingRequirement" type is a future time period, which means the analytics result is a prediction. If no sufficient data is collected to provide the confidence of the prediction before the time deadline, the NWDAF shall return a zero confidence.

appServerInsAddr

AddrFqdn

C

0..1

Represents the Application Server Instance (IP address/FQDN of the Application Server). Shall be present if the "appServerAddrs" attribute was provided in the request or subscription.

upfInfo

UpfInformation

C

0..1

Identifies the UPF. Shall be present only if the "upfInfo" attribute was provided in the request or subscription and the identified NF service consumer is not an AF or a NEF. (NOTE)

dnai

Dnai

C

0..1

Indicates the DN Access Identifier representing location of the service flow. Shall be present if the "dnais" attribute was provided in the request or subscription.

perfData

PerfData

M

1

Represents the performance data.

spatialValidCon

NetworkAreaInfo

C

0..1

Represents the area where the DN performance analytics applies. Shall be present if "networkArea" attribute was provided in the request or subscription.

temporalValidCon

TimeWindow

O

0..1

Represents the valid period for the DN performance analytics.

NOTE: This attribute shall not be provided if the NWDAF does not know the NF service consumer type or if the NWDAF knows that the NF service consumer is an AF or a NEF.

avgTrafficRate

BitRate

O

0..1

Indicates average traffic rate.

maxTrafficRate

BitRate

O

0..1

Indicates maximum traffic rate.

avePacketDelay

PacketDelBudget

O

0..1

Indicates average Packet Delay.

maxPacketDelay

PacketDelBudget

O

0..1

Indicates maximum Packet Delay.

avgPacketLossRate

PacketLossRate

O

0..1

Indicates average Loss Rate.

cpuUsage

Uinteger

O

0..1

Average usage of virtual CPU.

(NOTE)

Minimum=0. Maximum=100.

memoryUsage

Uinteger

O

0..1

Average usage of memory.

(NOTE)

Minimum=0. Maximum=100.

storageUsage

Uinteger

O

0..1

Average usage of storage.

(NOTE)

Minimum=0. Maximum=100.

NOTE: The values are percentages which are provided as estimated over a given period.

nfId

NfInstanceId

C

0..1

Identifies the analytics consumer NF instance. (NOTE)

nfSetId

NfSetId

C

0..1

Identifies the analytics consumer NF set. (NOTE)

taiList

array(Tai)

C

1..N

The list of TAIs the analytics consumer NF can serve. (NOTE)

NOTE: Either "taiList" or one of "nfId", "nfSetId" shall be provided.

disperType

DispersionType

M

1

Indicates the required dispersion analytics type.

classCriters

array(ClassCriterion)

O

1..N

Indicates the dispersion mobility class criterion for fixed, camper and/or traveller UE, and/or the top-heavy UE dispersion class criterion.

rankCriters

array(RankingCriterion)

O

1..N

Indicates the usage ranking criterion between the high, medium and low usage UE.

dispOrderCriter

DispersionOrderingCriterion

O

0..1

Indicates the ordering criterion for the list of UE Dispersion Analytics information.

order

MatchingDirection

O

0..1

Indicate the order: ascending or descending. May be present when the "dispOrderCriter" attribute is included. (NOTE)

NOTE: "CROSSED" value in date type "MatchingDirection" is not applicable for the "order" attribute.

disperClass

DispersionClass

M

1

Indicates the dispersion class.

classThreshold

SamplingRatio

M

1

Indicates the dispersion class threshold.

thresMatch

MatchingDirection

M

1

Indicates the dispersion class threshold matching direction. (NOTE)

NOTE: "CROSSED" value in date type "MatchingDirection" is not applicable for the "thresMatch" attribute.

highBase

SamplingRatio

M

1

Indicates the "high" ranking bottom baseline percentage.

lowBase

SamplingRatio

M

1

Indicates the "low" ranking top baseline percentage.

NOTE: UE is ranked high (i.e.value 1), medium (2) or low (3) when its data/transactions dispersed during the period of observation at the location/slice, is higher than "highBase" attribute value, within the range between the "highBase" attribute to "lowBase" attribute value or less than "lowBase" value, respectively.

tsStart

DateTime

M

1

Indicates the timestamp when the time slot starts during the Analytics target period.

tsDuration

DurationSec

M

1

Indicates the time slot duration.

disperCollects

array(DispersionCollection)

M

1..N

Dispersion collections on UE location(s) and/or slice(s).

disperType

DispersionType

M

1

Indicates the dispersion type. Only applicable to DVDA or TDA value.

ueLoc

UserLocation

C

0..1

TA or cells where the UE or group of UEs dispersed its transactions and/or data. Shall be present if "networkArea" attribute is included in the event subscription or analytics request. (NOTE 1)

snssai

Snssai

C

0..1

Slice where the UE or group of UEs disperse its transactions and/or data. Shall be present if "snssais" attribute is included in the event subscription or analytics request. (NOTE 1)

supis

array(Supi)

C

1..N

Each element identifies a SUPI of an UE. May only be present if reporting inside 5GC and the event subscription or analytics request applies to more than one UE. (NOTE 2)

gpsis

array(Gpsi)

C

1..N

Each element identifies a GPSI of an UE.

May only be present if reused by the Nnef_AnalyticsExposure service reporting to external AF and the event subscription or analytics request applies to more than one UE. (NOTE 2)

appVolumes

array(ApplicationVolume)

O

1..N

Application data volumes. May be present if "appIds" attribute is included in the event subscription or analytics request (NOTE 6).

disperAmount

Uinteger

C

0..1

Indicates the dispersion amount of the reported data volume or transaction dispersion type.

Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set to DISPER_AMOUNT. (NOTE 3)

disperClass

DispersionClass

C

0..1

Indicates the UE dispersion mobility class: fixed, camper, traveller, and/or the top-heavy dispersion class.

Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set to DISPER_CLASS. (NOTE 3, NOTE 5).

usageRank

integer

C

0..1

Usage ranked high (i.e.value 1), medium (2) or low (3).

Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set to RANKING. (NOTE 3, NOTE 6).

percentileRank

SamplingRatio

C

0..1

Percentile ranking of the target UE in the Cumulative Distribution Function of data usage for the population of all UEs.

Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set to PERCENTILE_RANKING. (NOTE 3, NOTE 6).

ueRatio

SamplingRatio

C

0..1

Contains the percentage of UEs with same analytics result in the group or among all UEs.

Shall be present if the analytics result applies for a group of UEs or any UE.

confidence

Uinteger

C

0..1

Indicates the confidence of the prediction. (NOTE 4)

Shall be present if the analytics result is a prediction.

Minimum = 0. Maximum = 100.

NOTE 1: One of "ueLoc" attribute or "snssai" attribute shall be provided.

NOTE 2: When Target of Analytics Reporting is a UE group ID, or "Any UE" and a filter for Top-Heavy UEs, fixed, camper or traveller is included in the subscription, the NWDAF shall include the list of UEs matching the filter. This information element shall not be present when Target of Analytic Reporting is "Any UE" and no filter for Top-Heavy UEs, fixed, camper or traveller is included.

NOTE 3: At least one value shall be provided. If the "listofAnaSubsets" attribute with value only applicable to "DISPERSION" event is present in the subscription request, then only the corresponding attribute(s) shall be present.

NOTE 4: If the requested period identified by the "startTs" and "endTs" attributes in the EventReportingRequirement type is a future time period, which means the analytics result is a prediction. If no sufficient data is collected to provide the confidence of the prediction before the time deadline, the NWDAF shall return a zero confidence.

NOTE 5: This parameter may only be provided when the Target of Analytics Reporting contains the "supis" attribute or the "gpsis" attribute in the "tgtUe" attribute.

NOTE 6: This parameter shall not be provided when the "anyUe" attribute in the "tgtUe" attribute for the Target of Analytics Reporting was set to true.

appId

ApplicationId

M

1

Application where the UE or group of UEs disperse its transactions and/or data. May be present if "appIds" attribute is included in the event subscription or analytics request.

appVolume

Volume

M

1

Indicates the dispersion data volume per application in units of bytes.

redTOrderCriter

RedTransExpOrderingCriterion

O

0..1

Indicates the ordering criterion for the list of UE Redundant Transmission Experience Analytics information. (NOTE 1)

order

MatchingDirection

O

0..1

Indicate the order: ascending or descending. May be present when the "redTOrderCriter" attribute is included. (NOTE 1) (NOTE 2)

NOTE 1: If no attribute or no value is provided, default ordering may be applied.

NOTE 2: "CROSSED" value in date type "MatchingDirection" is not applicable for the "order" attribute.

spatialValidCon

NetworkAreaInfo

C

0..1

Area where the Redundant Transmission Experience applies.

If "networkArea" attribute was provided in the request or subscription, shall be the requested network area.

dnn

Dnn