Analytics Exposure Subscriptions

/{afId}/subscriptions

GET

Read all subscriptions for a given AF

POST

Create a new subscription to analytics exposure

Individual Analytics Exposure Subscription

/{afId}/subscriptions /{subscriptionId}

GET

Read a subscription to analytics exposure

PUT

Modify all of the properties of an existing subscription to analytics exposure

DELETE

Delete a subscription to analytics exposure

apiRoot

string

Clause 5.2.4 of 3GPP TS 29.122 [4].

afId

string

Identifier of the AF.

supp-feat

SupportedFeatures

O

0..1

The features supported by the NF service consumer.

N/A

array(AnalyticsExposureSubsc)

M

0..N

200 OK

The subscription information for the AF in the request URI are returned.

N/A

307 Temporary Redirect

Temporary redirection, during subscription retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NEF.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].

N/A

308 Permanent Redirect

Permanent redirection, during subscription retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NEF.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].

NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 of 3GPP TS 29.122 [4] also apply.

Location

string

M

1

An alternative URI of the resource located in an alternative NEF.

Location

string

M

1

An alternative URI of the resource located in an alternative NEF.

AnalyticsExposureSubsc

M

1

Parameters to request a subscription to retrieve analytics information with the NEF.

AnalyticsExposureSubsc

M

1

201 Created

The subscription was created successfully.

The URI of the created resource shall be returned in the "Location" HTTP header.

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.6-1 of 3GPP TS 29.122 [4] also apply.

NOTE 2: Failure causes are described in clause 5.6.5.

Location

string

M

1

Contains the URI of the newly created resource, according to the structure:

{apiRoot}/3gpp-analyticsexposure/v1/{afId}/subscriptions/{subscriptionId}

apiRoot

string

Clause 5.2.4 of 3GPP TS 29.122 [4].

afId

string

Identifier of the AF.

subscriptionId

string

Identifier of the subscription resource.

supp-feat

SupportedFeatures

O

0..1

The features supported by the NF service consumer.

N/A

AnalyticsExposureSubsc

M

1

200 OK

The subscription information for the AF in the request URI are returned.

N/A

307 Temporary Redirect

Temporary redirection, during subscription retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NEF.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].

N/A

308 Permanent Redirect

Permanent redirection, during subscription retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NEF.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].

NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 of 3GPP TS 29.122 [4] also apply.

Location

string

M

1

An alternative URI of the resource located in an alternative NEF.

Location

string

M

1

An alternative URI of the resource located in an alternative NEF.

AnalyticsExposureSubsc

M

1

Modify an existing subscription to retrieve analytics information with the NEF.

AnalyticsExposureSubsc

M

1

200 OK

The subscription was updated successfully.

N/A

204 No Content

The subscription was updated successfully.

N/A

307 Temporary Redirect

Temporary redirection, during subscription modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NEF.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].

N/A

308 Permanent Redirect

Permanent redirection, during subscription modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NEF.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].

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 PUT method listed in table 5.2.6-1 of 3GPP TS 29.122 [4] also apply.

NOTE 2: Failure causes are described in clause 5.6.5.

Location

string

M

1

An alternative URI of the resource located in an alternative NEF.

Location

string

M

1

An alternative URI of the resource located in an alternative NEF.

N/A

N/A

N/A

204 No Content

The subscription was terminated successfully.

N/A

307 Temporary Redirect

Temporary redirection, during subscription termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NEF.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].

N/A

308 Permanent Redirect

Permanent redirection, during subscription termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NEF.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].

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

Location

string

M

1

An alternative URI of the resource located in an alternative NEF.

Location

string

M

1

An alternative URI of the resource located in an alternative NEF.

fetch

{apiRoot}/3gpp-analyticsexposure/v1/{afId}/fetch

POST

Request to fetch analytics information

AnalyticsRequest

M

1

Parameters to request to fetch analytics information.

AnalyticsData

M

1

200 OK

The requested analytics information was returned successfully.

n/a

204 No Content

If the request Analytics data does not exist, the NEF shall respond with "204 No Content".

N/A

307 Temporary Redirect

Temporary redirection, during analytics information retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NEF.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].

N/A

308 Permanent Redirect

Permanent redirection, during analytics information retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NEF.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].

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)

ProblemDetailsAnalyticsInfoRequest

O

0..1

500 Internal Server Error

The request is rejected by the NEF and more details (not only the ProblemDetails) may be returned.

(NOTE 2)

NOTE 1: The manadatory HTTP error status codes for the POST method listed in Table 5.2.6-1 of 3GPP TS 29.122 [4] also apply.

NOTE 2: Failure causes are described in clause 5.6.5.

Location

string

M

1

An alternative URI of the resource located in an alternative NEF.

Location

string

M

1

An alternative URI of the resource located in an alternative NEF.

Event Notification

{notifUri}

POST

The analytics event notification is provided by the NEF to the AF.

notifUri

Callback reference provided by the AF during creation/modification of the subscription within the AnalyticsExposureSubsc data type as defined in Table 5.6.3.3.2-1.

AnalyticsEventNotification

M

1

The analytics event notification is provided by the NEF to the AF.

N/A

204 No Content

The event notification is received successfully.

N/A

307 Temporary Redirect

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

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].

N/A

308 Permanent Redirect

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

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].

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

Location

string

M

1

An alternative URI representing the end point of an alternative AF towards which the notification should be redirected.

Location

string

M

1

An alternative URI representing the end point of an alternative AF towards which the notification should be redirected.

AbnormalExposure

5.6.3.3.15

Represents a user’s abnormal behavior information.

Abnormal_Behavior

AnalyticsData

5.6.3.3.14

Represents analytics data.

AnalyticsEvent

5.6.3.4.3

Event that is subscribed.

AnalyticsEventFilter

5.6.3.3.13

Represents analytics event filter information.

AnalyticsEventFilterSubsc

5.6.3.3.6

Represents an analytics event filter.

AnalyticsEventNotif

5.4.3.3.4

Represents an analytics event to be reported.

AnalyticsEventNotification

5.6.3.3.3

Represents an analytics event(s) notification.

AnalyticsEventSubsc

5.6.3.3.5

Represents a subscribed analytics event.

AnalyticsExposureSubsc

5.6.3.3.2

Represents an analytics exposure subscription.

AnalyticsFailureCode

5.6.3.4.4

Identifies the failure reason.

AnalyticsFailureEventInfo

5.6.3.3.20

Represents an event for which the subscription request was not successful and including the associated failure reason.

AnalyticsRequest

5.6.3.3.12

Represents the parameters to request to retrieve analytics information.

CongestInfo

5.6.3.3.16

Represents a UE’s user data congestion information.

Congestion

CongestionAnalytics

5.6.3.3.17

Represents data congestion analytics for transfer over the user plane, control plane or both.

NetworkPerfExposure

5.6.3.3.19

Represents network performance information.

Network_Performance

QosSustainabilityExposure

5.6.3.3.18

Represents a QoS sustainability information.

QoS_Sustainability

TargetUeId

5.6.3.3.7

Represents the target UE(s) information.

UeLocationInfo

5.6.3.3.10

Represents a UE location information.

UeMobilityExposure

5.6.3.3.9

Represents a UE mobility information.

Ue_Mobility

AdditionalMeasurement

3GPP TS 29.520 [27]

AddrFqdn

3GPP TS 29.517 [58]

AnalyticsSubset

3GPP TS 29.520 [27]

Analytics Subset.

ReportingInformation

3GPP TS 29.523 [22]

Describes the analytics reporting requirement information.

BitRate

3GPP TS 29.571 [8]

BwRequirement

3GPP TS 29.520 [27]

CongestionType

3GPP TS 29.520 [27]

DateTime

3GPP TS 29.122 [4]

DispersionInfo

3GPP TS 29.520 [27]

Dispersion information.

DispersionRequirement

3GPP TS 29.520 [27]

Dispersion requirement.

Dnai

3GPP TS 29.571 [8]

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

Dnn

3GPP TS 29.571 [8]

DnPerfInfo

3GPP TS 29.520 [27]

DN Performance information.

DnPerformanceReq

3GPP TS 29.520 [27]

DN Performance requirement.

DurationSec

3GPP TS 29.122 [4]

Seconds of duration.

EventReportingRequirement

3GPP TS 29.520 [27]

ExternalGroupId

3GPP TS 29.122 [4]

External Group Identifier for a user group.

ExceptionId

3GPP TS 29.520 [27]

ExpectedAnalyticsType

3GPP TS 29.520 [27]

ExpectedUeBehaviourData

3GPP TS 29.503 [17]

Float

3GPP TS 29.571 [8]

Gpsi

3GPP TS 29.571 [8]

Identifies a GPSI.

MatchingDirection

3GPP TS 29.520 [27]

Matching direction

NetworkPerfRequirement

3GPP TS 29.520 [27]

NsiIdInfo

3GPP TS 29.520 [27]

NwdafFailureCode

3GPP TS 29.520 [27]

Identifies the analytics failure reason.

ProblemDetailsAnalyticsInfoRequest

3GPP TS 29.520 [27]

QosRequirement

3GPP TS 29.520 [27]

RatFreqInformation

3GPP TS 29.520 [27]

RetainabilityThreshold

3GPP TS 29.520 [27]

SamplingRatio

3GPP TS 29.571 [8]

Indicates Sampling Ratio.

ScheduledCommunicationTime

3GPP TS 29.122 [4]

ServiceExperienceInfo

3GPP TS 29.520 [27]

Snssai

3GPP TS 29.571 [8]

SupportedFeatures

3GPP TS 29.571 [8]

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

TermCause

3GPP TS 29.520 [27]

Cause for requesting the termination of a subscription.

ThresholdLevel

3GPP TS 29.520 [27]

TimeWindow

3GPP TS 29.122 [4]

TopApplication

3GPP TS 29.520 [27]

Top application that contributes the most to the traffic.

UeCommunication

3GPP TS 29.520 [27]

Uinteger

3GPP TS 29.571 [8]

Unsigned integer.

Uri

3GPP TS 29.571 [8]

Identifies a referenced resource.

LocationArea5G

3GPP TS 29.122 [4]

analyEventsSubs

array(AnalyticsEventSubsc)

M

1..N

Subscribed analytics events.

analyRepInfo

ReportingInformation

O

0..1

Reporting requirement information of the subscription.

If omitted, the default values within the ReportingInformation data type apply. (NOTE 2)

notifUri

Uri

M

1

Notification URI for analytics event reporting.

notifId

string

M

1

Notification Correlation ID assigned by the NF service consumer.

eventNotifis

array(AnalyticsEventNotif)

C

1..N

Represents the Events to be reported.

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

failEventReports

array(AnalyticsFailureEventInfo)

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).

suppFeat

SupportedFeatures

C

0..1

Indicates the list of Supported features used as described in clause 5.6.4.

This attribute shall be provided in the POST request and in the response of successful resource creation, or in the HTTP GET response if the "supp-feat" attribute query parameter is included in the HTTP GET request.

self

Link

C

0..1

Identifies the Individual Analytics Exposure Subscription resource.

Shall be present in the HTTP GET response when reading all the subscriptions for an AF.

requestTestNotification

boolean

O

0..1

Set to true by the AF to request the NEF to send a test notification as defined in clause 5.2.5.3 of 3GPP TS 29.122 [4]. Set to false or omitted otherwise.

Notification_test_event

websockNotifConfig

WebsockNotifConfig

O

0..1

Configuration parameters to set up notification delivery over Websocket protocol.

Notification_websocket

NOTE 1: Properties marked with a feature as defined in clause 5.6.4 are applicable as described in clause 5.2.7 of 3GPP TS 29.122 [4]. If no feature is indicated, the related property applies for all the features.

NOTE 2: The attributes "partitionCriteria" and "notifFlag" of the data type ReportingInformation are applicable only if the "EneNA" feature is supported.

notifId

string

M

1

Notification Correlation ID assigned by the NF service consumer.

analyEventNotifs

array(AnalyticsEventNotif)

M

1..N

Represents the analytics events to be reported according to the subscription corresponding to the Notification Correlation ID.

termCause

TermCause

O

0..1

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

TermRequest

analyEvent

AnalyticsEvent

M

1

Detected analytics event.

expiry

DateTime

O

0..1

Defines the expiration time after which the analytics information will become invalid. (NOTE 2)

timeStamp

DateTime

M

1

Time at which the event is observed.

failNotifyCode

AnalyticsFailureCode

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 1)

EneNA

rvWaitTime

DurationSec

O

0..1

Indicates 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

ueMobilityInfos

array(UeMobilityExposure)

C

1..N

Contains the UE mobility information.

Shall be present if the "analyEvent" attribute sets to "UE_MOBILITY".

Ue_Mobility

ueCommInfos

array(UeCommunication)

C

1..N

Contains the application communication information.

Shall be present if the "analyEvent" attribute sets to "UE_COMM".

Ue_Communication

abnormalInfos

array(AbnormalExposure)

C

1..N

Contains the user’s abnormal behavior information.

Shall be present if the "analyEvent" attribute sets to "ABNORMAL_BEHAVIOR".

Abnormal_Behavior

congestInfos

array(CongestInfo)

C

1..N

Contains the UE’s user data congestion information.

Shall be present if the "analyEvent" attribute sets to "CONGESTION".

Congestion

nwPerfInfos

array(NetworkPerfExposure)

C

1..N

Contains the network performance information.

Shall be present if the "analyEvent" attribute is set to "NETWORK_PERFORMANCE".

Network_Performance

qosSustainInfos

array(QosSustainabilityExposure)

C

1..N

Contains the QoS sustainability information.

Shall be present if the "analyEvent" attribute is set to "QOS_SUSTAINABILITY".

QoS_Sustainability

disperInfos

array(DispersionInfo)

C

1..N

Contains the Dispersion information.

Shall be present if the "analyEvent" attribute is set to "DISPERSION".

Dispersion

dnPerfInfos

array(DnPerfInfo)

C

1..N

Contains the DN performance information.

Shall be present if the "analyEvent" attribute is set to "DN_PERFORMANCE".

DnPerformance

svcExps

array(ServiceExperienceInfo)

C

1..N

Contains the service experience information.

Shall be present if the “analyEvent” attribute is set to "SERVICE_EXPERIENCE".

ServiceExperience

timeStampGen

DateTime

O

0..1

It defines the timestamp of analytics generation.

EneNA

start

DateTime

O

0..1

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

EneNA

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

NOTE 2: 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.

analyEvent

AnalyticsEvent

M

1

Requested analytics event.

analyEventFilter

AnalyticsEventFilterSubsc

O

0..1

Represents analytics event filter.

(NOTE)

tgtUe

TargetUeId

O

0..1

Identifies target UE information

(NOTE)

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

locArea

LocationArea5G

O

0..1

Identification of network area to which the subscription applies.

(NOTE 1) (NOTE 7)

Abnormal_Behavior

Congestion

Ue_Communication

Ue_Mobility

QoS_Sustainability

Network_Performance

Dispersion

DnPerformance

ServiceExperience

dnn

Dnn

O

0..1

Identifies the DNN. (NOTE 7)

Ue_Communication

Abnormal_Behavior

ServiceExperience

DnPerformance

dnais

array(Dnai)

O

1..N

Identification(s) of user plane access to DN(s) which the subscription applies.

DnPerformance

ServiceExperience

appIds

array(ApplicationId)

O

1..N

Each element identifies an application. (NOTE 7)

Abnormal_Behavior

Ue_Communication

Dispersion

DnPerformance

ServiceExperience

excepRequs

array(Exception)

O

1..N

Represents a list of Exception Ids with associated thresholds.

(NOTE 2, NOTE 3)

Abnormal_Behavior

exptAnaType

ExpectedAnalyticsType

O

0..1

Represents expected UE analytics type.

(NOTE 3)

Abnormal_Behavior

exptUeBehav

ExpectedUeBehaviourData

O

0..1

Represents expected UE behaviour.

Abnormal_Behavior

matchingDir

MatchingDirection

O

0..1

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

QoS_Sustainability

Congestion,

Network_Performance

reptThlds

array(ThresholdLevel)

O

1..N

Represents the levels to be reached in order to be notified by the NEF.

(NOTE 4)

Congestion

nwPerfReqs

array(NetworkPerfRequirement)

C

1..N

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

Network_Performance

snssai

Snssai

O

0..1

Identifies the network slice information. (NOTE 7)

Ue_Communication

QoS_Sustainability

Abnormal_Behavior

Congestion

Dispersion

ServiceExperience

DnPerformance

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 "SERVICE_EXPERIENCE" or "DN_PERFORMANCE".

ServiceExperience

DnPerformance

qosReq

QosRequirement

C

0..1

Represents the QoS requirements. This attribute shall be included when eventId is "QOS_SUSTAINABILITY".

QoS_Sustainability

qosFlowRetThds

array(RetainabilityThreshold)

C

1..N

Represents the QoS flow retainability thresholds,

Shall be supplied for the 5QI of GBR resource type. (NOTE 5)

QoS_Sustainability

ranUeThrouThds

array(BitRate)

C

1..N

Represents the RAN UE throughput thresholds.

Shall be supplied for the 5QI of non-GBR resource type. (NOTE 5)

QoS_Sustainability

disperReqs

array(DispersionRequirement)

O

1..N

Represents the dispersion analytics requirements.

Dispersion

dnPerfReqs

array(DnPerformanceReq)

O

1..N

Represents the DN performance analytics requirements.

DnPerformance

bwRequs

array(BwRequirement)

O

1..N

Represents the bandwidth requirement for each application.

ServiceExperience

ratFreqs

array(RatFreqInformation)

O

1..N

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

ServiceExperience

appServerAddrs

array(AddrFqdn)

C

1..N

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

ServiceExperience

DnPerformance

listOfAnaSubsets

array(AnalyticsSubset)

O

1..N

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

EneNA

extraReportReq

EventReportingRequirement

O

0..1

The extra event reporting requirement information. (NOTE 6)

maxNumOfTopAppUl

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 element in the "listOfAnaSubsets" attribute is set to LIST_OF_TOP_APP_UL.

CongestionExt

maxNumOfTopAppDl

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 element in the "listOfAnaSubsets" attribute is set to LIST_OF_TOP_APP_DL.

CongestionExt

visitedLocAreas

array(LocationArea5G)

O

1..N

Identifications of network areas which the UEs had previously been in at least one of the Visited Area(s) of Interest.

(NOTE 10)

Ue_Mobility

NOTE 1: The NetworkAreaInfo within the "locArea" attribute is not applicable for the untrusted AF. For "NETWORK_PERFORMANCE" or "CONGESTION" event, the "locArea" attribute shall be provided if the event applied for all UEs (i.e. "anyUeInd" attribute set to true within the TargetUeId data). For "QOS_SUSTAINABILITY" event, the "locArea" attribute shall be provided.

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

NOTE 3: Either "excepRequs" or "exptAnaType" shall be provided if the subscribed event is "ABNORMAL_BEHAVIOR".

NOTE 4: If the subscribed event is "CONGESTION" or "DN_PERFORMANCE", this attribute shall be provided if "notifMethod" within "analyRepInfo" sets to "ON_EVENT_DETECTION" or omitted.

NOTE 5: For "QOS_SUSTAINABILITY", this property shall be provided if the "notifMethod" in "analyRepInfo" is set to "ON_EVENT_DETECTION" or omitted.

NOTE 6: The "sampRatio" attribute within EventReportingRequirement data type is not applicable for the present API. The attributes "accPerSubset", "offsetPeriod", and "timeAnaNeeded" within the EventReportingRequirement data type are applicable only if the "EneNA" feature is supported.

NOTE 7: For "ABNORMAL_BEHAVIOR" event with "anyUeId" attribute in "tgtUe" attribute sets to true,

– at least one of the "locArea" and the "snssai" 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 "locArea", "appIds", "dnn" and "snssai" 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 8: If both the "allFreq" attribute and the "allRat" attribute within the "ratFreqs" attribute are present, then the cardinality shall be 1 as the "all" indication for all the RAT type and Frequency value the NWDAF has received for the application.

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

NOTE 10: The NetworkAreaInfo within the "visitedLocAreas" attribute is not applicable for the untrusted AF. If this attribute is provided, the analytics target period shall be a past time period (i.e. only statistics is supported).

anyUeInd

boolean

O

0..1

Identifies whether the AF request applies to any UE.

This attribute shall set to "true" if applicable for any UE, otherwise, set to "false".

Abnormal_Behavior

Congestion

Network_Performance

QoS_Sustainability

Dispersion

DnPerformance

ServiceExperience

gpsi

Gpsi

O

0..1

Identifies a GPSI for an UE.

Abnormal_Behavior

Congestion

Ue_Mobility

Ue_Communication

Network_Performance

Dispersion

DnPerformance

ServiceExperience

exterGroupId

ExternalGroupId

O

0..1

Represents an external group identifier and identifies a group of UEs.

Abnormal_BehaviorUe_Mobility

Ue_Communication

Network_Performance

Dispersion

DnPerformance

ServiceExperience

NOTE: For an applicable feature, only one attribute identifying the target UE shall be provided.

ts

DateTime

O

0..1

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

recurringTime

ScheduledCommunicationTime

O

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.

locInfo

array(UeLocationInfo)

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

LocationArea5G

M

1

This attribute contains the detailed location.

ratio

SamplingRatio

C

0..1

This attribute contains the percentage of UEs 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, a zero confidence shall be returned.

analyEvent

AnalyticsEvent

M

1

Identifies the analytics type.

analyEventFilter

AnalyticsEventFilter

C

0..1

Shall be included to identify the analytics when filter information is needed for the related event.

analyRep

EventReportingRequirement

O

0..1

Identifies the analytics reporting requirement information. (NOTE)

tgtUe

TargetUeId

O

0..1

Identifies the target UE information.

suppFeat

SupportedFeatures

M

1

Represents the features supported by the NF service consumer.

NOTE: The attributes "accPerSubset", "offsetPeriod", and "timeAnaNeeded" within the EventReportingRequirement data type are applicable only if the "EneNA" feature is supported.

locArea

LocationArea5G

C

0..1

This IE represents the network area where the NF service consumer wants to know the analytics result.

(NOTE 2, NOTE 3)

Ue_Mobility

Ue_Communication

Network_Performance

QoS_Sustainability

Abnormal_Behavior

Congestion

Dispersion

DnPerformance

ServiceExperience

dnn

Dnn

O

0..1

Identifies the DNN. (NOTE 3)

Ue_Communication

Abnormal_Behavior

DnPerformance

ServiceExperience

dnais

array(Dnai)

O

1..N

Identification(s) of user plane access to DN(s) which the subscription applies.

DnPerformance

ServiceExperience

nwPerfTypes

array(NetworkPerfType)

C

1..N

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

Network_Performance

appIds

array(ApplicationId)

O

1..N

Each element identifies an application. The absence of appIds means all applications. (NOTE 3)

Ue_Communication Abnormal_Behavior

DnPerformance

ServiceExperience

Dispersion

excepIds

array(ExceptionId)

O

1..N

Represents a list of Exception Ids. (NOTE 1)

Abnormal_Behavior

exptAnaType

ExpectedAnalyticsType

O

0..1

Represents expected UE analytics type. (NOTE 1)

Abnormal_Behavior

exptUeBehav

ExpectedUeBehaviourData

O

0..1

Represents expected UE behaviour.

Abnormal_Behavior

snssai

Snssai

O

0..1

Identifies the network slice information. (NOTE 3)

Ue_Communication

QoS_Sustainability

Abnormal_Behavior

Congestion

Dispersion

DnPerformance

ServiceExperience

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 "SERVICE_EXPERIENCE" or "DN_PERFORMANCE".

ServiceExperience

DnPerformance

qosReq

QosRequirement

C

0..1

Represents the QoS requirements. This attribute shall be included when analyEvent is "QOS_SUSTAINABILITY".

QoS_Sustainability

listOfAnaSubsets

array(AnalyticsSubset)

O

1..N

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

EneNA

dnPerfReqs

array(DnPerformanceReq)

O

1..N

Represents the DN performance analytics requirements.

DnPerformance

bwRequs

array(BwRequirement)

O

1..N

Represents the media/application bandwidth requirement for each application.

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

ServiceExperience

ratFreqs

array(RatFreqInformation)

O

1..N

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

ServiceExperience

appServerAddrs

array(AddrFqdn)

C

1..N

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

ServiceExperience

DnPerformance

disperReqs

array(DispersionRequirement)

O

1..N

Represents the requirements of dispersion analytics.

Dispersion

maxNumOfTopAppUl

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.

CongestionExt

maxNumOfTopAppDl

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.

CongestionExt

visitedLocAreas

array(LocationArea5G)

O

1..N

Identifications of network areas which the UEs had previously been in at least one of the Visited Area(s) of Interest.

(NOTE 6)

Ue_Mobility

NOTE 1: Either "excepIds" or "exptAnaType" shall be provided if the subscribed event is "ABNORMAL_BEHAVIOR".

NOTE 2: The NetworkAreaInfo within the "locArea" attribute is not applicable for the untrusted AF. For "NETWORK_PERFORMANCE" or "CONGESTION" event, the "locArea" attribute shall be provided if the event applied for all UEs (i.e. "anyUeInd" attribute set to true within the TargetUeId data). For "QOS_SUSTAINABILITY" event, this attribute shall be provided.

NOTE 3: For "ABNORMAL_BEHAVIOR" event with "anyUeId" attribute in "tgtUe" attribute sets to true,

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

– at least one of the "locArea", "appIds", "dnn" and "snssai" attribute should be included, if the expected analytics type via the"exptAnaType" attribute or the list of Exception Ids via the "excepIds" attribute is communication related;

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

NOTE 4: If both the "allFreq" attribute and the "allRat" attribute within the "ratFreqs" attribute are present, then the cardinality shall be 1 as the "all" indication for all the RAT type and Frequency value the NWDAF has received for the application.

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

NOTE 6: The NetworkAreaInfo within the "visitedLocAreas" attribute is not applicable for the untrusted AF. If this attribute is provided, the analytics target period shall be a past time period (i.e. only statistics is supported).

start

DateTime

O

0..1

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

EneNA

expiry

DateTime

O

0..1

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

timeStampGen

DateTime

O

0..1

It defines the timestamp of analytics generation.

EneNA

ueMobilityInfos

array(UeMobilityExposure)

C

1..N

Contains the UE mobility information.

Shall be present if the "analyEvent" attribute sets to "UE_MOBILITY"

Ue_Mobility

ueCommInfos

array(UeCommunication)

C

1..N

Contains the application communication information.

Shall be present if the "analyEvent" attribute sets to "UE_COMM"

Ue_Communication

nwPerfInfos

array(NetworkPerfExposure)

C

1..N

Contains the network performance information.

Shall be present if the "analyEvent" attribute is set to "NETWORK_PERFORMANCE".

Network_Performance

abnormalInfos

array(AbnormalExposure)

C

1..N

Contains the user’s abnormal behavior information.

Shall be present if the "analyEvent" attribute sets to "ABNORMAL_BEHAVIOR".

Abnormal_Behavior

congestInfos

array(CongestInfo)

C

1..N

Contains the UE’s user data congestion information.

Shall be present if the "analyEvent" attribute sets to "CONGESTION".

Congestion

qosSustainInfos

array(QosSustainabilityExposure)

C

1..N

Contains the QoS sustainability information.

Shall be present if the "analyEvent" attribute is set to "QOS_SUSTAINABILITY".

(NOTE 2)

QoS_Sustainability

disperInfos

array(DispersionInfo)

C

1..N

Contains the Dispersion information.

Shall be present if the "analyEvent" attribute is set to "DISPERSION".

Dispersion

dnPerfInfos

array(DnPerfInfo)

C

1..N

Contains the DN performance information.

Shall be present if the "analyEvent" attribute is set to "DN_PERFORMANCE".

DnPerformance

svcExps

array(ServiceExperienceInfo)

C

1..N

Contains the service experience information.

Shall be present if the "analyEvent" attribute is set to "SERVICE_EXPERIENCE".

ServiceExperience

suppFeat

SupportedFeatures

M

1

Represents the features supported by both the AF and the NEF.

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 "qosFlowRetThd" and "ranUeThrouThd" attributes in QosSustainabilityExposure data type are not applicable.

gpsis

array(Gpsi)

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.

excep

Exception

M

1

Contains the exception information.

appId

ApplicationId

O

0..1

Identifies an application. May only be present if the "appIds" attribute was provided within AnalyticsEventFilter during the subscription for event notification procedure.

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.

Abnormal_Behavior_Ext

snssai

Snssai

O

0..1

Identifies the network slice information.

Abnormal_Behavior_Ext

ratio

SamplingRatio

C

0..1

This attribute 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, a zero confidence shall be returned.

locArea

LocationArea5G

M

1

Network area of interest. (NOTE)

cngAnas

array(CongestionAnalytics)

M

1..N

Represents data congestion analytics for transfer over the user plane, control plane or both planes.

NOTE: The NetworkAreaInfo data within the LocationArea5G data is not applicable.

cngType

CongestionType

M

1

Represents congestion type.

tmWdw

TimeWindow

M

1

Represents a start time and a stop time observed for the congestion information.

nsi

ThresholdLevel

M

1

Represents network congestion level.

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 element in the "listOfAnaSubsets" attribute was set to LIST_OF_TOP_APP_UL.

CongestionExt

topAppListDl

array(TopApplication)

C

1..N

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

CongestionExt

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, a zero confidence shall be returned.

locArea

LocationArea5G

M

1

Identification(s) of applicable location areas where the analytics result applies. (NOTE 3)

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

O

0..1

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

(NOTE 1)

ranUeThrouThd

BitRate

O

0..1

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

(NOTE 1)

snssai

Snssai

O

0..1

Identifies the network slice information.

QoS_Sustainability_Ext

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 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, a zero confidence shall be returned.

NOTE 3: The NetworkAreaInfo data within the LocationArea5G data is not applicable.

locArea

LocationArea5G

M

1

Identification of network area to which the subscription applies. (NOTE 3)

nwPerfType

NetworkPerfType

M

1

The type of the network performance

relativeRatio

SamplingRatio

O

0..1

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

absoluteNum

Uinteger

O

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, a zero confidence shall be returned.

NOTE 3: The NetworkAreaInfo data within the LocationArea5G data is not applicable.

event

AnalyticsEvent

M

1

Event that is subscribed.

failureCode

AnalyticsFailureCode

M

1

Identifies the failure reason

UE_MOBILITY

The AF requests to be notified about analytics information of UE mobility.

Ue_Mobility

UE_COMM

The AF requests to be notified about analytics information of UE communication.

Ue_Communication

ABNORMAL_BEHAVIOR

The AF requests to be notified about analytics information of UE’s abnormal behavior.

Abnormal_Behavior

CONGESTION

The AF requests to be notified about analytics information of user data congestion information.

Congestion

NETWORK_PERFORMANCE

The AF requests to be notified about analytics information of network performance information.

Network_Performance

QOS_SUSTAINABILITY

The AF requests to be notified about analytics information of QoS sustainability.

QoS_Sustainability

DISPERSION

The AF requests to be notified about analytics information of Dispersion information.

Dispersion

DN_PERFORMANCE

The AF requests to be notified about analytics information of DN performance information.

DnPerformance

SERVICE_EXPERIENCE

The AF requests to be notified about analytics information of service experience.

ServiceExperience

BOTH_STAT_PRED_NOT_ALLOWED

The event is rejected since the start time is in the past and the end time is in the future, which means the NF service consumer requested both statistics and prediction for the analytics.

UNAVAILABLE_DATA

The event is rejected since necessary data to perform the service is unavailable.

UNSATISFIED_REQUESTED_ANALYTICS_TIME

Indicates that the requested event is rejected since the analytics information is not ready when the time indicated by the "timeAnaNeeded" attribute (as provided during the creation or modification of subscription) is reached.

EneNA

OTHER

The event is rejected due to other reasons.

1

Ue_Mobility

This feature indicates support for the analytics event related to UE mobility.

2

Ue_Communication

This feature indicates support for the analytics event related to UE communication information.

3

Abnormal_Behavior

This feature indicates support for the analytics event related to UE’s abnormal behaviour.

4

Congestion

This feature indicates support for the analytics event related to UE’s user data congestion information.

5

Network_Performance

This feature indicates support for the analytics event related to network performance.

6

QoS_Sustainability

This feature indicates support for the analytics event related to QoS sustainability.

7

Notification_websocket

The delivery of notifications over Websocket is supported as described in 3GPP TS 29.122 [4]. This feature requires that the Notification_test_event feature is also supported.

8

Notification_test_event

The testing of notification connection is supported as described in 3GPP TS 29.122 [4].

9

Dispersion

This feature indicates support for the analytics event related to Dispersion analytics.

10

EneNA

This feature indicates support for the enhancements of network data analytics requirements.

11

DnPerformance

This feature indicates the support of the analytics event related to DN performance.

12

ServiceExperience

This feature indicates support for the event related to service experience.

13

CongestionExt

This feature indicates support for the extensions to the event related to user data congestion, including support of GPSI and/or list of Top applications. Supporting this feature also requires the support of feature Congestion.

14

Abnormal_Behavior_Ext

This feature indicates support for the extensions to the event related to abnormal behavior, including support of exposing DNN and S-NSSAI information.

Supporting this feature also requires the support of feature Abnormal_Behavior.

15

QoS_Sustainability_Ext

This feature indicates support for the extensions to the event related to QoS sustainability, including support of exposing S-NSSAI information.

Supporting this feature also requires the support of feature QoS_Sustainability.

16

TermRequest

This feature indicates support for Analytics Exposure Subscription termination requests sent by the NEF to the NF service consumer.

BOTH_STAT_PRED_NOT_ALLOWED

400 Bad Request

For the requested observation period, the start time is in the past and the end time is in the future, which means the AF requested both statistics and prediction for the analytics.

USER_CONSENT_NOT_GRANTED

403 Forbidden

Indicates that the request shall be rejected because an impacted user has not provided the required user consent.

UNAVAILABLE_DATA

500 Internal Server Error

Indicates the requested statistics in the past is rejected since necessary data to perform the service is unavailable.

UNSATISFIED_REQUESTED_ANALYTICS_TIME

500 Internal Server Error

Indicates that the requested event is rejected since the analytics information is not ready when the time indicated by the "timeAnaNeeded" attribute (as provided during the request) is reached.