Application Event Subscriptions

/subscriptions

POST

Subscription to the notification of application events and creation of an Individual Application Event Subscription resource.

Individual Application Event Subscription

/subscriptions/{subscriptionId}

GET

Reads an Individual Application Event Subscription resource.

PUT

Modifies an Individual Application Event Subscription.

DELETE

Cancels an individual subscription to notifications of application event.

apiRoot

string

See clause 5.1

n/a

AfEventExposureSubsc

M

1

Contains the information required for the creation of a new individual application event subscription.

AfEventExposureSubsc

M

1

201 Created

Contains the representation of the Individual Application Event Subscription resource.

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

Location

string

M

1

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

apiRoot

string

See clause 5.1

subscriptionId

string

Identifies a subscription to the AF event exposure service.

supp-feat

SupportedFeatures

O

0..1

The features supported by the NF service consumer.

n/a

AfEventExposureSubsc

M

1

200 OK

Contains the representation of the Individual Application Event Subscription resource.

RedirectResponse

O

0..1

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 AF (service) instance.

Applicable if the feature "ES3XX" is supported.

(NOTE 2)

RedirectResponse

O

0..1

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 AF (service) instance.

Applicable if the feature "ES3XX" is supported.

(NOTE 2)

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

NOTE 2: If the AF is untrusted, the Redirection handling described in clause 5.2.10 of 3GPP TS 29.122 [17] should apply.

Location

string

M

1

An alternative URI of the resource located in an alternative AF (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 AF (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

AfEventExposureSubsc

M

1

Modifies the existing Individual Application Event Subscription resource.

AfEventExposureSubsc

M

1

200 OK

Successful case.

The Individual Application Event Subscription resource was modified and a representation is returned.

n/a

204 No Content

Successful case.

The Individual Application Event Subscription resource was modified.

RedirectResponse

O

0..1

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 AF (service) instance.

Applicable if the feature "ES3XX" is supported.

(NOTE 2)

RedirectResponse

O

0..1

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 AF (service) instance.

Applicable if the feature "ES3XX" is supported.

(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 [5] also apply.

NOTE 2: If the AF is untrusted, the Redirection handling described in clause 5.2.10 of 3GPP TS 29.122 [17] should apply.

Location

string

M

1

An alternative URI of the resource located in an alternative AF (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 AF (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

n/a

n/a

204 No Content

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

RedirectResponse

O

0..1

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 AF (service) instance.

Applicable if the feature "ES3XX" is supported.

(NOTE 2)

RedirectResponse

O

0..1

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 AF (service) instance.

Applicable if the feature "ES3XX" is supported.

(NOTE 2)

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

NOTE 2: If the AF is untrusted, the Redirection handling described in clause 5.2.10 of 3GPP TS 29.122 [17] should apply.

Location

string

M

1

An alternative URI of the resource located in an alternative AF (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 AF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

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

Application Event Notification

{notifUri}

POST

Notification of application related event reporting.

notifUri

Uri

The Notification Uri as assigned by the NF service consumer during the subscription service operation and described within the AfEventExposureSubsc data type (see table 5.6.2.2-1).

n/a

AfEventExposureNotif

M

1

Provides Information about observed application related events

n/a

204 No Content

The receipt of the Notification is acknowledged.

RedirectResponse

O

0..1

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 NF consumer (service) instance where the notification should be sent.

Applicable if the feature "ES3XX" is supported.

(NOTE 2)

RedirectResponse

O

0..1

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 NF consumer (service) instance where the notification should be sent.

Applicable if the feature "ES3XX" is supported.

(NOTE 2)

NOTE 1: In addition, the HTTP status codes which are specified as mandatory in table 5.2.7.1-1 of 3GPP TS 29.500 [5] for the POST method shall also apply.

NOTE 2: If the AF is untrusted, the Redirection handling described in clause 5.2.10 of 3GPP TS 29.122 [17] should 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.

AddrFqdn

5.6.2.18

IP address and/or FQDN.

PerformanceData

ServiceExperienceExt

AfEvent

5.6.3.3

Represents Application Events.

AfEventExposureSubsc

5.6.2.2

Represents an Individual Application Event Subscription resource.

AfEventExposureNotif

5.6.2.3

Describes notifications about application event that occurred in an Individual Application Event Subscription resource.

AfEventNotification

5.6.2.6

Represents information related to an event to be reported.

CollectiveBehaviourFilter

5.6.2.19

Contains the parameter type and value pair to express the collective behaviour event filters.

CollectiveBehaviour

CollectiveBehaviourFilterType

5.6.3.4

CollectiveBehaviour

CollectiveBehaviourInfo

5.6.2.20

Contains the collective behaviour analytics information.

CollectiveBehaviour

CommunicationCollection

5.6.2.13

Contains communication information.

UeCommunication

DispersionCollection

5.6.2.21

Contains Dispersion information collected.

Dispersion

EventFilter

5.6.2.5

Represents event filter information

EventsSubs

5.6.2.4

Represents an event to be subscribed and the related event filter information.

ExceptionInfo

5.6.2.14

Describes the exceptions information provided by AF.

Exceptions

MSAccessActivityCollection

5.6.2.27

Represents the Media Streaming access activities of UE Application collected via Data Collection AF.

MSAccessActivity

MsConsumptionCollection

5.6.2.24

Represents the Media Streaming Consumption reports of UE Application collected via Data Collection AF.

MSConsumption

MsDynPolicyInvocationCollection

5.6.2.26

Represents the Media Streaming Dynamic Policy invocation of UE Application collected via Data Collection AF.

MSDynPolicyInvocation

MsQoeMetricsCollection

5.6.2.23

Represents the Media Streaming QoE Metrics of UE Application collected via Data Collection AF.

MSQoeMetrics

MsNetAssInvocationCollection

5.6.2.25

Represents the Media Streaming Network Assistance invocation of UE Application collected via Data Collection AF.

MSNetAssInvocation

PerformanceData

5.6.2.17

Indicates the performance data.

PerformanceData

PerformanceDataCollection

5.6.2.16

Represents the performance data information collected for an AF application.

PerformanceData

PerUeAttribute

5.6.2.22

UE application data collected per UE.

CollectiveBehaviour

ServiceExperienceInfoPerApp

5.6.2.7

Contains service experience associated with the application

ServiceExperience

ServiceExperienceInfoPerFlow

5.6.2.8

Contains service experience associated with the service flow

ServiceExperience

SvcExperience

5.6.2.9

Contains a mean opinion score with the customized range.

ServiceExperience

UeCommunicationCollection

5.6.2.11

Contains UE communication information associated with the application.

UeCommunication

UeMobilityCollection

5.6.2.10

Contains UE mobility information associated with the application.

UeMobility

UeTrajectoryCollection

5.6.2.12

Contains UE trajectory information associated with the application.

UeMobility

UserDataCongestionCollection

5.6.2.15

Contains User Data Congestion Analytics related information collected.

UserDataCongestion

ApplicationId

3GPP TS 29.571 [13]

Application Identifier.

BitRate

3GPP TS 29.571 [13]

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

UserDataCongestion

CollectiveBehaviour

DateTime

3GPP TS 29.571 [13]

Contains a date and a time.

Dnai

3GPP TS 29.571 [13]

Identifies a DNAI.

DurationSec

3GPP TS 29.571 [13]

Indicates a period of time in units of seconds.

Dispersion

DynamicPolicy

3GPP TS 26.512 [30]

Represents the Media Streaming Dynamic Policy.

MSDynPolicyInvocation

EthFlowDescription

3GPP TS 29.514 [18]

Defines a packet filter for an Ethernet flow.

Exception

3GPP TS 29.520 [19]

Describes the Exception information.

Float

3GPP TS 29.571 [13]

Number with format "float" as defined in OpenAPI Specification [8].

FlowDescription

3GPP TS 29.514 [18]

Only IP 5-tuple (protocol, source and destination IP address, Source and destination port) is applicable.

Dispersion

FlowInfo

3GPP TS 29.122 [17]

Represents flow information.

Gpsi

3GPP TS 29.571 [13]

Identifies a GPSI.

GroupId

3GPP TS 29.571 [13]

Contains a Group identifier.

IpAddr

3GPP TS 29.571 [13]

Identifies IP address.

Dispersion

LocationArea5G

3GPP TS 29.122 [17]

Represents a user location area when the UE is attached to 5G.

MediaStreamingAccessRecord

3GPP TS 26.512 [30]

Represents the Media Streaming Access activity record.

MSAccessActivity

NetworkAssistanceSession

3GPP TS 26.512 [30]

Represents the Media Streaming Network Assistance Session recommandation.

MSNetAssInvocation

PacketDelBudget

3GPP TS 29.571 [13]

Indicates average Packet Delay.

PerformanceData

PacketLossRate

3GPP TS 29.571 [13]

Indicates average Loss Rate.

PerformanceData

RedirectResponse

3GPP TS 29.571 [13]

Contains redirection related information.

ES3XX

ReportingInformation

3GPP TS 29.523 [12]

Represents the requirements of reporting the subscription.

SupportedFeatures

3GPP TS 29.571 [13]

Indicates the features supported.

TimeWindow

3GPP TS 29.122 [17]

Represents a time window identified by a start time and a stop time.

Uri

3GPP TS 29.571 [13]

Contains a URI.

Volume

3GPP TS 29.122 [17]

Unsigned integer identifying a volume in units of bytes.

UsageThreshold

3GPP TS 29.122 [17]

data volume during the period

Dispersion

Supi

3GPP TS 29.571 [13]

Contains a SUPI.

ExtGroupId

3GPP TS 29.503 [27]

External Group Identifier for a user group.

dataAccProfId

string

O

0..1

Represents a unique identifier for the Data Access Profile.

DataAccProfileId

eventsSubs

array(EventsSubs)

M

1..N

Subscribed events and the related event filters.

eventsRepInfo

ReportingInformation

M

1

Represents the reporting requirements of the subscription.

notifUri

Uri

M

1

Notification URI for event reporting.

notifId

string

M

1

Notification Correlation ID assigned by the NF service consumer.

eventNotifs

array(AfEventNotification)

C

1..N

Represents the Events to be reported.

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

suppFeat

SupportedFeatures

C

0..1

This IE represents a list of Supported features used as described in clause 5.8.

Shall be present in the HTTP POST request/response; or in the HTTP GET response if the "supp-feat" attribute query parameter is included in the HTTP GET request. (NOTE)

NOTE: In the HTTP POST request it represents the set of NF service consumer supported features. In the HTTP POST and GET responses it represents the set of features supported by both the NF service consumer and the AF.

notifId

string

M

1

Notification Correlation ID assigned by the NF service consumer.

eventNotifs

array(AfEventNotification)

M

1..N

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

event

AfEvent

M

1

Subscribed event.

eventFilter

EventFilter

M

1

Represents the event filter information associated with each event.

gpsis

array(Gpsi)

O

1..N

Each element represents external UE identifier.

(NOTE 1, NOTE 2)

supis

array(Supi)

O

1..N

Each element represents a SUPI identifying a UE (NOTE 1, NOTE 2)

exterGroupIds

array(ExtGroupId)

O

1..N

Each element represents a group of UEs identified by an External Group Identifier.

(NOTE 1, NOTE 2)

interGroupIds

array(GroupId)

O

1..N

Each element represents a group of UEs identified by an Internal Group Identifier (NOTE 1, NOTE 2)

anyUeInd

boolean

O

0..1

Identifies whether the request applies to any UE.

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

May only be present and sets to "true" if "AfEvent" sets to "SVC_EXPERIENCE", "EXCEPTIONS" or "USER_DATA_CONGESTION".

(NOTE 2)

ServiceExperience

Exceptions

UserDataCongestion

appIds

array(ApplicationId)

O

1..N

Each element indicates an application identifier.

If absent, the EventFilter data applies to any application (i.e. all applications)

(NOTE 3)

ServiceExperience

UeMobility

UeCommunication

Exceptions

UserDataCongestion

PerformanceData

Dispersion

CollectiveBehaviour

MSQoeMetrics

MSConsumption

MSNetAssInvocation

MSDynPolicyInvocation

MSAccessActivity

locArea

LocationArea5G

O

0..1

Represents area of interest. (NOTE 5)

ServiceExperience

UeMobility

UeCommunication

Exceptions

UserDataCongestion

PerformanceData

Dispersion

CollectiveBehaviour

MSQoeMetrics

MSConsumption

MSNetAssInvocation

MSDynPolicyInvocation

MSAccessActivity

collAttrs

array(CollectiveBehaviourFilter)

O

1..N

Each element indicates a collective attribute parameter type and value.

CollectiveBehaviour

NOTE 1: For untrusted AF, only gpsis and exterGroupIds are applicable. For trusted AF, only supis and interGroupIds are applicable.

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

NOTE 3: For event "UE_COMM", "UE_MOBILITY", "EXCEPTIONS" and "PERF_DATA", the "appIds" attribute, if present, shall include only one element.

NOTE 4: Properties marked with a feature as defined in clause 5.8 are applicable as described in clause 6.6 of 3GPP TS 29.500 [5]. If no features are indicated, the related property applies for all the features.

NOTE 5: The NetworkAreaInfo data within the LocationArea5G data is only applicable for trusted AF. In addition, for event "SVC_EXPERIENCE", only the "tais" attribute within the NetworkAreaInfo data is applicable for the trusted AF.

event

AfEvent

M

1

Represents the reported application related event.

timeStamp

DateTime

M

1

Time at which the event is observed.

svcExprcInfos

array(ServiceExperienceInfoPerApp)

C

1..N

Contains the service experience information.

Shall be present if the "event" attribute sets to "SVC_EXPERIENCE"

ServiceExperience

ueMobilityInfos

array(UeMobilityCollection)

C

1..N

Contains the UE mobility information.

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

UeMobility

ueCommInfos

array(UeCommunicationCollection)

C

1..N

Contains the application communication information.

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

UeCommunication

excepInfos

array(ExceptionInfo)

C

1..N

Each element represents the exception information for a service flow.

Shall be present if the "event" attribute sets to "EXCEPTIONS".

Exceptions

congestionInfos

array(UserDataCongestionCollection)

C

1..N

Each element represents the user data congestion information collected for an AF application.

Shall be present if the "event" attribute sets to "USER_DATA_CONGESTION".

UserDataCongestion

perfDataInfos

array(PerformanceDataCollection)

C

1..N

Each element represents the performance data information collected for an AF application.

Shall be present if the "event" attribute sets to "PERF_DATA".

PerformanceData

collBhvrInfs

array(CollectiveBehaviourInfo)

C

1..N

Each element represents the collective behaviour information related to a set of UEs, applications. Shall be present if the "event" attribute sets to "COLLECTIVE_BEHAVIOUR".

CollectiveBehaviour

dispersionInfos

array(DispersionCollection)

C

1..N

Each element represents the UE dispersion information collected for an AF application.

Shall be present if the "event" attribute sets to "DISPERSION".

Dispersion

msQoeMetrInfos

array(MsQoeMetricsCollection)

C

1..N

Each element represents the Media Streaming QoE metrics information collected for an UE application via the Data Collection AF.

Shall be present if the "event" attribute sets to " MS_QOE_METRICS".

MSQoeMetrics

msConsumpInfos

array(MsConsumptionCollection)

C

1..N

Each element represents the Media Streaming Consumption information collected for an UE application via the Data Collection AF.

Shall be present if the "event" attribute sets to "MS_CONSUMPTION".

MSConsumption

msNetAssInvInfos

array(MsNetAssInvocationCollection)

C

1..N

Each element represents the Media Streaming Network Assistance invocation information collected for an UE application via the Data Collection AF.

Shall be present if the "event" attribute sets to "NET_ASSIST_INVOCATION".

MSNetAssInvocation

msDynPlyInvInfos

array(MsDynPolicyInvocationCollection)

C

1..N

Each element represents the Media Streaming Dynamic Policy invocation information collected for an UE application via the Data Collection AF.

Shall be present if the "event" attribute sets to "MS_DYN_POLICY_INVOCATION".

MSDynPolicyInvocation

msAccActInfos

array(MSAccessActivityCollection)

C

1..N

Each element represents the Media Streaming access activity collected for an UE application via the Data Collection AF.

Shall be present if the "event" attribute sets to "MS_ACCESS_ACTIVITY".

MSAccessActivity

appId

ApplicationId

C

0..1

Indicates an application identifier.

Shall be present if the AF event exposure service request applies to more than one application.

appServerIns

AddrFqdn

O

0..1

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

ServiceExperienceExt

svcExpPerFlows

array(ServiceExperienceInfoPerFlow)

M

1..N

Each element represents service experience for each service flow.

gpsis

array(Gpsi)

O

1..N

Each element represents external UE identifier. (NOTE)

supis

array(Supi)

O

1..N

SUPI identifying a UE. (NOTE)

NOTE: Either gpsis or supis shall be present. For untrusted AF, only gpsis is applicable. For trusted AF, only supis is applicable.

svcExprc

SvcExperience

M

1

Service experience

timeIntev

TimeWindow

M

1

Represents a start and stop time of the measurement period for the AF service experience.

dnai

Dnai

O

0..1

Indicates the DN Access Identifiers representing location of the service flow.

ipTrafficFilter

FlowInfo

O

0..1

Identifies IP packet filter.(NOTE)

ethTrafficFilter

EthFlowDescription

O

0..1

Identifies Ethernet packet filter.(NOTE)

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

mos

Float

M

1

Mean opinion score.

upperRange

Float

M

1

The upper value within the rating scale range

lowerRange

Float

M

1

The lower value within the rating scale range

gpsi

Gpsi

O

0..1

Identifies a UE. (NOTE 1)

supi

Supi

O

0..1

SUPI identifying a UE. (NOTE 1)

appId

ApplicationId

M

1

Identifies an application identifier.

allAppInd

boolean

O

0..1

Indicates applicable to all applications if set to "true", otherwise set to "false". Default value is "false" if omitted. (NOTE 2)

AllApplications

ueTrajs

array(UeTrajectoryCollection)

M

1..N

Identifies a list of UE moving trajectories.

NOTE 1: Either gpsi or supi shall be present. For untrusted AF, only gpsi is applicable. For trusted AF, only supi is applicable.

NOTE 2: If the "allAppInd" attribute is present and set to "true", then the value in the "appId" shall be ignored, which indicates the collected UE mobility information is applicable to all the applications for the UE.

gpsi

Gpsi

O

0..1

Identifies a UE. (NOTE 1)

supi

Supi

O

0..1

SUPI identifying a UE. (NOTE 1)

exterGroupId

ExtGroupId

O

0..1

Identifies an external group of UEs. (NOTE 2)

interGroupId

GroupId

O

0..1

Identifies an internal group of UEs. (NOTE 2)

appId

ApplicationId

M

1

Identifies an application identifier.

comms

array(CommunicationCollection)

M

1..N

This attribute contains a list of communication information.

NOTE 1: Either gpsi or supi shall be present. For untrusted AF, only gpsi is applicable. For trusted AF, only supi is applicable.

NOTE 2: "interGroupId" attribute only applies to trusted AF and "exterGroupId" only applies to untrusted AF.

ts

DateTime

M

1

This attribute identifies the timestamp when the UE enters the location.

locArea

LocationArea5G

M

1

This attribute includes the location information of the UE.

startTime

DateTime

M

1

Identifies the timestamp this communication starts.

endTime

DateTime

M

1

Identifies the timestamp this communication stops.

ulVol

Volume

O

0..1

Identifies the uplink traffic volume. (NOTE)

dlVol

Volume

O

0..1

Identifies the downlink traffic volume. (NOTE)

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

ipTrafficFilter

FlowInfo

C

0..1

Identifies IP flow.(NOTE 1)

ethTrafficFilter

EthFlowDescription

C

0..1

Identifies Ethernet flow.(NOTE 1)

exceps

array(Exception)

M

1..N

Contains the description of one or more exception information. (NOTE 2)

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

NOTE 2: Only "excepId", "excepLevel" and "excepTrend" within the Exception data type as defined in 3GPP TS 29.520 [19] apply to the ExceptionInfo data type.

appId

ApplicationId

C

0..1

Indicates an application identifier.

(NOTE)

ipTrafficFilter

FlowInfo

C

0..1

Identifies IP packet filter. (NOTE)

timeInterv

TimeWindow

O

0..1

Represents a start and stop time interval of the measurement period for the AF application.

thrputUl

BitRate

O

0..1

Indicates the average uplink throughput over the measurement period.

thrputDl

BitRate

O

0..1

Indicates the average downlink throughput over the measurement period.

thrputPkUl

BitRate

O

0..1

Indicates the peak uplink throughput over the measurement period.

thrputPkDl

BitRate

O

0..1

Indicates the peak uplink throughput over the measurement period.

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

appId

ApplicationId

O

0..1

Indicates an application identifier.

ueIpAddr

IpAddr

O

0..1

Identifies the IP address of an UE.

ipTrafficFilter

FlowInfo

O

0..1

Identifies IP packet filter.

ueLoc

LocationArea5G

O

0..1

Represents the UE location.

appLocs

array(Dnai)

O

1..N

Represents the application locations.

asAddr

AddrFqdn

O

0..1

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

perfData

PerformanceData

M

1

Indicates the performance data.

timeStamp

DateTime

M

1

It defines the timestamp of analytics generation.

NOTE: If the "asAddr" attribute is included, either the "ipAddr" attribute or the "fqdn" attribute in the AddrFqdn data type shall be provided.

pdb

PacketDelBudget

O

0..1

Indicates average Packet Delay.

plr

PacketLossRate

O

0..1

Indicates average Loss Rate.

thrputUl

BitRate

O

0..1

Indicates the average uplink throughput.

thrputDl

BitRate

O

0..1

Indicates the average downlink throughput.

ipAddr

IpAddr

O

0..1

Indicates an IP address.

fqdn

string

O

0..1

Indicates an FQDN.

type

CollectiveBehaviourFilterType

M

1

Parameter type for collective behaviour information event filter.

value

string

M

1

Value of the parameter type as in "type" attribute.

listOfUeInd

boolean

O

0..1

Indicates whether request list of UE IDs that fulfill a collective behaviour within the area of interest.

This attribute shall set to "true" if request the list of UE IDs, otherwise, set to "false".

May only be present and sets to "true" if "AfEvent" sets to "COLLECTIVE_BEHAVIOUR".

colAttrib

array(PerUeAttribute)

M

1..N

The list of collective attribute values.

noOfUes

integer

O

0..1

Identifies the total number of UEs that fulfil a collective behaviour within the area of interest.

appIds

array(ApplicationId)

O

1..N

Indicates the identifiers of the applications providing this information.

extUeIds

array(Gpsi)

C

1..N

Gpsi information of the UEs that fulfil the collective behaviour with in the area of the interest. May only be present if the "listOfUe" attribute is subscribed and sets to "true".

(NOTE)

ueIds

array(Supi)

C

1..N

Supis of UEs that fulfil the collective behaviour with in the area of the interest. May only be present if the "listOfUe" attribute is subscribed and sets to "true". (NOTE)

NOTE: Only one of "extUeIds" or "ueIds" shall be provided. "ueIds" attribute may only be provided by trusted AF.

gpsi

Gpsi

C

0..1

Indicates external UE identifier. (NOTE 1)

supi

Supi

C

0..1

Indicates internal UE identifier, represents a SUPI identifying a UE (NOTE 1)

ueAddr

IpAddr

C

0..1

Indicates UE IP address. (NOTE 1)

dataUsage

UsageThreshold

M

1

Data volume exchanged for the UE. (NOTE 3)

flowDesp

FlowDescription

C

0..1

Represents IP 5-tuple with protocol, IP address and port for UL/DL application traffic. (NOTE 2)

appId

ApplicationId

C

0..1

Indicates an Application Identifier. (NOTE 2)

dnais

array(Dnai)

O

1..N

Indicates the DN Access Identifiers representing location of the service flow.

May only be provided if the "ueAddr" attribute is provided.

appDur

DurationSec

O

0..1

Indicates the duration for the application.

NOTE 1: One of the "supi", "gpsi" or "ueAddr" attribute shall be provided.

NOTE 2: If the "ueAddr" attribute is provided, either the "appId" or "flowDesp" attribute shall be provided.

NOTE 3: The "duration" attribute within the UsageThreshold data type is not applicable.

ueDest

LocationArea5G

M

1

Expected final location of UE based on the route planned.

route

string

O

0..1

Planned path of movement by a UE application (e.g. a navigation app). The format is based on the SLA.

avgSpeed

BitRate

O

0..1

Expected speed over the route planned by a UE application.

timeOfArrival

DateTime

O

0..1

Expected Time of arrival to destination based on the route planned.

msQoeMetrics

array(string)

M

1..N

Represents the Media Streaming Quality of Experience metrics with formatting as specified in clause 11.4.3 of 3GPP TS 26.512 [30], if required for the QoE metrics for Media Streaming UE Application.

msConsumps

array(string)

M

1..N

Represents the Media Streaming Consumption reports with formatting as specified in clause 11.3.3 of 3GPP TS 26.512 [30], if required for Media Streaming UE Application.

msNetAssInvocs

array(NetworkAssistanceSession)

M

1..N

Indicate Media Streaming Network Assistance invocation information as specified in clause 11.6.3.1 of 3GPP TS 26.512 [30].

msDynPlyInvocs

array(DynamicPolicy)

M

1..N

Represent the Media Streaming Dynamic Policy invocation as specified in clause 11.5.3.1 of 3GPP TS 26.512 [30].

msAccActs

array(MediaStreamingAccessRecord)

M

1..N

Indicate Media Streaming access activities information as specified in clause 17.2 of 3GPP TS 26.512 [30].

SVC_EXPERIENCE

Indicates that the event subscribed is service experience information for an application.

ServiceExperience

UE_MOBILITY

Indicates that the event subscribed is UE mobility information.

UeMobility

UE_COMM

Indicates that the event subscribed is UE communication information.

UeCommunication

EXCEPTIONS

Indicates that the event subscribed is exceptions information.

Exceptions

USER_DATA_CONGESTION

Indicates that the event subscribed is user data congestion analytics related information.

UserDataCongestion

PERF_DATA

Indicates that the event subscribed is performance data information.

PerformanceData

COLLECTIVE_BEHAVIOUR

Indicates that the event subscribed is collective behaviour information.

CollectiveBehaviour

DISPERSION

Indicates that the event subscribed is dispersion information.

Dispersion

MS_QOE_METRICS

Indicates that the event subscribed is Media Streaming QoE metrics.

MSQoeMetrics

MS_CONSUMPTION

Indicates that the event subscribed is Media Streaming Consumption reports.

MSConsumption

MS_NET_ASSIST_INVOCATION

Indicates that the event subscribed is Media Streaming Network Assistance invocation.

MSNetAssInvocation

MS_DYN_POLICY_INVOCATION

Indicates that the event subscribed is Media Streaming Dynamic Policy invocation.

MSDynPolicyInvocation

MS_ACCESS_ACTIVITY

Indicates that the event subscribed is Media Streaming access activity.

MSAccessActivity

COLLECTIVE_ATTRIBUTE

Parameter type related to collective attributes.

DATA_PROCESSING

Parameter type related to data processing type.

1

ServiceExperience

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

2

UeMobility

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

3

UeCommunication

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

4

Exceptions

This feature indicates support for the event related to exception information.

5

ES3XX

Extended Support for 3xx redirections. This feature indicates the support of redirection for any service operation, according to Stateless NF procedures as specified in clauses 6.5.3.2 and 6.5.3.3 of 3GPP TS 29.500 [5] and according to HTTP redirection principles for indirect communication, as specified in clause 6.10.9 of 3GPP TS 29.500 [5].

6

EneNA

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

7

UserDataCongestion

This feature indicates support for the event related to User Data Congestion Analytics related information.

8

PerformanceData

This feature indicates support for the event related to performance data information.

9

Dispersion

This feature indicates support for the event related to Dispersion Analytics related information.

10

CollectiveBehaviour

This feature indicates support for the event related to collective behaviour information.

11

ServiceExperienceExt

This feature indicates support for the extensions to the event related to service experience, including reporting Application Server Instance. Supporting this feature also requires the support of feature ServiceExperience.

12

MSQoeMetrics

This feature indicates support for the event related to Media Streaming QoE metrics for UE Application collected via the Data Collection AF.

13

MSConsumption

This feature indicates support for the event related to Media Streaming Consumption reports for UE Application collected via the Data Collection AF.

14

MSNetAssInvocation

This feature indicates support for the event related to Media Streaming Network Assistance invocation for UE Application collected via the Data Collection AF.

15

MSDynPolicyInvocation

This feature indicates support for the event related to Media Streaming Dynamic Policy invocation for UE Application collected via the Data Collection AF.

16

MSAccessActivity

This feature indicates support for the event related to Media Streaming access activity for UE Application collected via the Data Collection AF.

17

DataAccProfileId

This feature indicates support for Data Access Profile Identifier.

18

AllApplications

This feature indicates applicable to all the applications.