A.2 Naf_EventExposure API
29.5173GPP5G SystemApplication Function Event Exposure ServiceRelease 18Stage 3TS
openapi: 3.0.0
info:
version: 1.3.0-alpha.1
title: Naf_EventExposure
description: |
AF Event Exposure Service.
© 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: >
3GPP TS 29.517 V18.0.0; 5G System; Application Function Event Exposure Service; Stage 3.
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.517/
servers:
– url: ‘{apiRoot}/naf-eventexposure/v1’
variables:
apiRoot:
default: https://example.com
description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501
security:
– {}
– oAuth2ClientCredentials: []
paths:
/subscriptions:
post:
summary: Creates a new Individual Application Event Exposure Subscription resource
operationId: PostAfEventExposureSubsc
tags:
– Application Event Subscription (Collection)
requestBody:
required: true
content:
application/json:
schema:
$ref: ‘#/components/schemas/AfEventExposureSubsc’
responses:
‘201’:
description: Success
content:
application/json:
schema:
$ref: ‘#/components/schemas/AfEventExposureSubsc’
headers:
Location:
description: >
Contains the URI of the created individual application event subscription resource
required: true
schema:
type: string
‘400’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/400’
‘401’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/401’
‘403’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/403’
‘404’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/404’
‘411’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/411’
‘413’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/413’
‘415’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/415’
‘429’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/429’
‘500’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/500’
‘502’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/502’
‘503’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/503’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
callbacks:
AfEventExposureNotif:
‘{$request.body#/notifUri}’:
post:
requestBody:
required: true
content:
application/json:
schema:
$ref: ‘#/components/schemas/AfEventExposureNotif’
responses:
‘204’:
description: No Content, Notification was successful
‘307’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/307’
‘308’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/308’
‘400’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/400’
‘401’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/401’
‘403’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/403’
‘404’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/404’
‘411’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/411’
‘413’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/413’
‘415’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/415’
‘429’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/429’
‘500’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/500’
‘502’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/502’
‘503’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/503’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
/subscriptions/{subscriptionId}:
get:
summary: "Reads an existing Individual Application Event Subscription"
operationId: GetAfEventExposureSubsc
tags:
– Individual Application Event Subscription (Document)
parameters:
– name: subscriptionId
in: path
description: Application Event Subscription ID
required: true
schema:
type: string
– name: supp-feat
in: query
description: Features supported by the NF service consumer
required: false
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
responses:
‘200’:
description: OK. Resource representation is returned
content:
application/json:
schema:
$ref: ‘#/components/schemas/AfEventExposureSubsc’
‘307’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/307’
‘308’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/308’
‘400’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/400’
‘401’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/401’
‘403’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/403’
‘404’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/404’
‘406’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/406’
‘429’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/429’
‘500’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/500’
‘502’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/502’
‘503’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/503’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
put:
summary: "Modifies an existing Individual Application Event Subscription "
operationId: PutAfEventExposureSubsc
tags:
– Individual Application Event Subscription (Document)
requestBody:
required: true
content:
application/json:
schema:
$ref: ‘#/components/schemas/AfEventExposureSubsc’
parameters:
– name: subscriptionId
in: path
description: Application Event Subscription ID
required: true
schema:
type: string
responses:
‘200’:
description: OK. Resource was successfully modified and representation is returned
content:
application/json:
schema:
$ref: ‘#/components/schemas/AfEventExposureSubsc’
‘204’:
description: No Content. Resource was successfully modified
‘307’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/307’
‘308’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/308’
‘400’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/400’
‘401’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/401’
‘403’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/403’
‘404’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/404’
‘411’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/411’
‘413’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/413’
‘415’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/415’
‘429’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/429’
‘500’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/500’
‘502’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/502’
‘503’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/503’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
delete:
summary: "Cancels an existing Individual Application Event Subscription "
operationId: DeleteAfEventExposureSubsc
tags:
– Individual Application Event Subscription (Document)
parameters:
– name: subscriptionId
in: path
description: Application Event Subscription ID
required: true
schema:
type: string
responses:
‘204’:
description: No Content. Resource was successfully deleted
‘307’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/307’
‘308’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/308’
‘400’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/400’
‘401’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/401’
‘403’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/403’
‘404’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/404’
‘429’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/429’
‘500’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/500’
‘502’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/502’
‘503’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/503’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
components:
securitySchemes:
oAuth2ClientCredentials:
type: oauth2
flows:
clientCredentials:
tokenUrl: ‘{tokenUri}’
scopes: {}
description: >
For trusted AF, the ‘naf-eventexposure’ shall be used as ‘scopes’ and
‘{nrfApiRoot}/oauth2/token’ shall be used as ‘tokenUri’.
schemas:
AfEventExposureNotif:
description: >
Represents notifications on application event(s) that occurred for an Individual Application
Event Subscription resource.
type: object
properties:
notifId:
type: string
eventNotifs:
type: array
items:
$ref: ‘#/components/schemas/AfEventNotification’
minItems: 1
required:
– notifId
– eventNotifs
AfEventExposureSubsc:
description: Represents an Individual Application Event Subscription resource.
type: object
properties:
dataAccProfId:
type: string
eventsSubs:
type: array
items:
$ref: ‘#/components/schemas/EventsSubs’
minItems: 1
eventsRepInfo:
$ref: ‘TS29523_Npcf_EventExposure.yaml#/components/schemas/ReportingInformation’
notifUri:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Uri’
notifId:
type: string
eventNotifs:
type: array
items:
$ref: ‘#/components/schemas/AfEventNotification’
minItems: 1
suppFeat:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
required:
– eventsSubs
– eventsRepInfo
– notifId
– notifUri
AfEventNotification:
description: Represents information related to an event to be reported.
type: object
properties:
event:
$ref: ‘#/components/schemas/AfEvent’
timeStamp:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/DateTime’
svcExprcInfos:
type: array
items:
$ref: ‘#/components/schemas/ServiceExperienceInfoPerApp’
minItems: 1
ueMobilityInfos:
type: array
items:
$ref: ‘#/components/schemas/UeMobilityCollection’
minItems: 1
ueCommInfos:
type: array
items:
$ref: ‘#/components/schemas/UeCommunicationCollection’
minItems: 1
excepInfos:
type: array
items:
$ref: ‘#/components/schemas/ExceptionInfo’
minItems: 1
congestionInfos:
type: array
items:
$ref: ‘#/components/schemas/UserDataCongestionCollection’
minItems: 1
perfDataInfos:
type: array
items:
$ref: ‘#/components/schemas/PerformanceDataCollection’
minItems: 1
dispersionInfos:
type: array
items:
$ref: ‘#/components/schemas/DispersionCollection’
minItems: 1
collBhvrInfs:
type: array
items:
$ref: ‘#/components/schemas/CollectiveBehaviourInfo’
minItems: 1
msQoeMetrInfos:
type: array
items:
$ref: ‘#/components/schemas/MsQoeMetricsCollection’
minItems: 1
msConsumpInfos:
type: array
items:
$ref: ‘#/components/schemas/MsConsumptionCollection’
minItems: 1
msNetAssInvInfos:
type: array
items:
$ref: ‘#/components/schemas/MsNetAssInvocationCollection’
minItems: 1
msDynPlyInvInfos:
type: array
items:
$ref: ‘#/components/schemas/MsDynPolicyInvocationCollection’
minItems: 1
msAccActInfos:
type: array
items:
$ref: ‘#/components/schemas/MSAccessActivityCollection’
minItems: 1
required:
– event
– timeStamp
EventsSubs:
description: Represents an event to be subscribed and the related event filter information.
type: object
properties:
event:
$ref: ‘#/components/schemas/AfEvent’
eventFilter:
$ref: ‘#/components/schemas/EventFilter’
required:
– event
– eventFilter
EventFilter:
description: Represents event filter information for an event.
type: object
properties:
gpsis:
type: array
items:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Gpsi’
minItems: 1
supis:
type: array
items:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Supi’
minItems: 1
exterGroupIds:
type: array
items:
$ref: ‘TS29503_Nudm_SDM.yaml#/components/schemas/ExtGroupId’
minItems: 1
interGroupIds:
type: array
items:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/GroupId’
anyUeInd:
type: boolean
appIds:
type: array
items:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/ApplicationId’
minItems: 1
locArea:
$ref: ‘TS29122_CommonData.yaml#/components/schemas/LocationArea5G’
collAttrs:
type: array
items:
$ref: ‘#/components/schemas/CollectiveBehaviourFilter’
minItems: 1
ServiceExperienceInfoPerApp:
description: Contains service experience information associated with an application.
type: object
properties:
appId:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/ApplicationId’
appServerIns:
$ref: ‘#/components/schemas/AddrFqdn’
svcExpPerFlows:
type: array
items:
$ref: ‘#/components/schemas/ServiceExperienceInfoPerFlow’
minItems: 1
gpsis:
type: array
items:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Gpsi’
minItems: 1
supis:
type: array
items:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Supi’
minItems: 1
required:
– svcExpPerFlows
ServiceExperienceInfoPerFlow:
description: Contains service experience information associated with a service flow.
type: object
properties:
svcExprc:
$ref: ‘#/components/schemas/SvcExperience’
timeIntev:
$ref: ‘TS29122_CommonData.yaml#/components/schemas/TimeWindow’
dnai:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Dnai’
ipTrafficFilter:
$ref: ‘TS29122_CommonData.yaml#/components/schemas/FlowInfo’
ethTrafficFilter:
$ref: ‘TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/EthFlowDescription’
SvcExperience:
description: Contains a mean opinion score with the customized range.
type: object
properties:
mos:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Float’
upperRange:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Float’
lowerRange:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Float’
UeMobilityCollection:
description: >
Contains UE mobility information associated with an application. 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.
type: object
properties:
gpsi:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Gpsi’
supi:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Supi’
appId:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/ApplicationId’
allAppInd:
type: boolean
description: >
Indicates applicable to all applications if set to true, otherwise set to false.
Default value is false if omitted.
ueTrajs:
type: array
items:
$ref: ‘#/components/schemas/UeTrajectoryCollection’
minItems: 1
required:
– appId
– ueTrajs
UeCommunicationCollection:
description: Contains UE communication information associated with an application.
type: object
properties:
gpsi:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Gpsi’
supi:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Supi’
exterGroupId:
$ref: ‘TS29503_Nudm_SDM.yaml#/components/schemas/ExtGroupId’
interGroupId:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/GroupId’
appId:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/ApplicationId’
comms:
type: array
items:
$ref: ‘#/components/schemas/CommunicationCollection’
minItems: 1
required:
– appId
– comms
UeTrajectoryCollection:
description: Contains UE trajectory information associated with an application.
type: object
properties:
ts:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/DateTime’
locArea:
$ref: ‘TS29122_CommonData.yaml#/components/schemas/LocationArea5G’
required:
– ts
– locArea
CommunicationCollection:
description: Contains communication information.
type: object
properties:
startTime:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/DateTime’
endTime:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/DateTime’
ulVol:
$ref: ‘TS29122_CommonData.yaml#/components/schemas/Volume’
dlVol:
$ref: ‘TS29122_CommonData.yaml#/components/schemas/Volume’
required:
– startTime
– endTime
– ulVol
– dlVol
ExceptionInfo:
description: Represents the exceptions information provided by the AF.
type: object
properties:
ipTrafficFilter:
$ref: ‘TS29122_CommonData.yaml#/components/schemas/FlowInfo’
ethTrafficFilter:
$ref: ‘TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/EthFlowDescription’
exceps:
type: array
items:
$ref: ‘TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/Exception’
minItems: 1
required:
– exceps
oneOf:
– required: [ipTrafficFilter]
– required: [ethTrafficFilter]
UserDataCongestionCollection:
description: Contains User Data Congestion Analytics related information collection.
type: object
properties:
appId:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/ApplicationId’
ipTrafficFilter:
$ref: ‘TS29122_CommonData.yaml#/components/schemas/FlowInfo’
timeInterv:
$ref: ‘TS29122_CommonData.yaml#/components/schemas/TimeWindow’
thrputUl:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/BitRate’
thrputDl:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/BitRate’
thrputPkUl:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/BitRate’
thrputPkDl:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/BitRate’
oneOf:
– required: [appId]
– required: [ipTrafficFilter]
PerformanceDataCollection:
description: Contains Performance Data Analytics related information collection.
type: object
properties:
appId:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/ApplicationId’
ueIpAddr:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/IpAddr’
ipTrafficFilter:
$ref: ‘TS29122_CommonData.yaml#/components/schemas/FlowInfo’
ueLoc:
$ref: ‘TS29122_CommonData.yaml#/components/schemas/LocationArea5G’
appLocs:
type: array
items:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Dnai’
minItems: 1
asAddr:
$ref: ‘#/components/schemas/AddrFqdn’
perfData:
$ref: ‘#/components/schemas/PerformanceData’
timeStamp:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/DateTime’
required:
– perfData
– timeStamp
PerformanceData:
description: Contains Performance Data.
type: object
properties:
pdb:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/PacketDelBudget’
plr:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/PacketLossRate’
thrputUl:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/BitRate’
thrputDl:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/BitRate’
AddrFqdn:
description: IP address and/or FQDN.
type: object
properties:
ipAddr:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/IpAddr’
fqdn:
type: string
description: Indicates an FQDN.
DispersionCollection:
description: Contains the dispersion information collected for an AF.
type: object
properties:
gpsi:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Gpsi’
supi:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Supi’
ueAddr:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/IpAddr’
dataUsage:
$ref: ‘TS29122_CommonData.yaml#/components/schemas/UsageThreshold’
flowDesp:
$ref: ‘TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/FlowDescription’
appId:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/ApplicationId’
dnais:
type: array
items:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Dnai’
minItems: 1
appDur:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/DurationSec’
required:
– dataUsage
oneOf:
– required: [gpsi]
– required: [supi]
– required: [ueAddr]
CollectiveBehaviourFilter:
description: Contains the collective behaviour filter information to be collected from UE.
type: object
properties:
type:
$ref: ‘#/components/schemas/CollectiveBehaviourFilterType’
value:
type: string
description: Value of the parameter type as in the type attribute.
listOfUeInd:
type: boolean
description: >
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".
required:
– type
– value
CollectiveBehaviourInfo:
description: Contains the collective behaviour information to be reported to the subscriber.
type: object
properties:
colAttrib:
type: array
items:
$ref: ‘#/components/schemas/PerUeAttribute’
minItems: 1
noOfUes:
type: integer
description: Total number of UEs that fulfil a collective within the area of interest.
appIds:
type: array
items:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/ApplicationId’
minItems: 1
extUeIds:
type: array
items:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Gpsi’
minItems: 1
ueIds:
type: array
items:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Supi’
minItems: 1
required:
– colAttrib
oneOf:
– required: [extUeIds]
– required: [ueIds]
PerUeAttribute:
description: UE application data collected per UE.
type: object
properties:
ueDest:
$ref: ‘TS29122_CommonData.yaml#/components/schemas/LocationArea5G’
route:
type: string
avgSpeed:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/BitRate’
timeOfArrival:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/DateTime’
MsQoeMetricsCollection:
description: >
Contains the Media Streaming QoE metrics information collected for an UE Application via AF.
type: object
properties:
msQoeMetrics:
type: array
items:
type: string
minItems: 1
required:
– msQoeMetrics
MsConsumptionCollection:
description: >
Contains the Media Streaming Consumption information collected for an UE Application via AF.
type: object
properties:
msConsumps:
type: array
items:
type: string
description: >
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.
minItems: 1
required:
– msConsumps
MsNetAssInvocationCollection:
description: >
Contains the Media Streaming Network Assistance invocation collected for an UE Application
via AF.
type: object
properties:
msNetAssInvocs:
type: array
items:
$ref: ‘TS26512_M5_NetworkAssistance.yaml#/components/schemas/NetworkAssistanceSession’
minItems: 1
required:
– msNetAssInvocs
MsDynPolicyInvocationCollection:
description: >
Contains the Media Streaming Dynamic Policy invocation collected for an UE
Application via AF.
type: object
properties:
msDynPlyInvocs:
type: array
items:
$ref: ‘TS26512_M5_DynamicPolicies.yaml#/components/schemas/DynamicPolicy’
minItems: 1
required:
– msDynPlyInvocs
MSAccessActivityCollection:
description: Contains Media Streaming access activity collected for an UE Application via AF.
type: object
properties:
msAccActs:
type: array
items:
$ref: ‘TS26512_R4_DataReporting.yaml#/components/schemas/MediaStreamingAccessRecord’
minItems: 1
required:
– msAccActs
# Simple data types and Enumerations
AfEvent:
description: Represents Application Events.
anyOf:
– type: string
enum:
– SVC_EXPERIENCE
– UE_MOBILITY
– UE_COMM
– EXCEPTIONS
– USER_DATA_CONGESTION
– PERF_DATA
– DISPERSION
– COLLECTIVE_BEHAVIOUR
– MS_QOE_METRICS
– MS_CONSUMPTION
– MS_NET_ASSIST_INVOCATION
– MS_DYN_POLICY_INVOCATION
– MS_ACCESS_ACTIVITY
– type: string
description: >
This string provides forward-compatibility with future extensions to the enumeration but
is not used to encode content defined in the present version of this API.
CollectiveBehaviourFilterType:
description: Represents collective behaviour parameter type.
anyOf:
– type: string
enum:
– COLLECTIVE_ATTRIBUTE
– DATA_PROCESSING
– type: string
description: >
This string provides forward-compatibility with future extensions to the enumeration but
is not used to encode content defined in the present version of this API.
Annex B (informative):
Change history
|
Change history |
|||||||
|
Date |
TSG # |
TSG Doc. |
CR |
Rev |
Cat |
Subject/Comment |
New |
|
2019-03 |
TS skeleton of Application Function Event Exposure Service |
0.0.0 |
|||||
|
2019-04 |
CT3#102 |
Inclusion of C3-191230, C3-191374 and editorial change from Rapporteur. |
0.1.0 |
||||
|
2019-05 |
CT3#103 |
Inclusion of C3-192194, C3-192393, C3-192260 and C3-192261. |
0.2.0 |
||||
|
2019-08 |
CT3#105 |
Inclusion of C3-193373, C3-193440, C3-193441 and C3-193446. |
0.3.0 |
||||
|
2019-10 |
CT3#106 |
Inclusion of C3-194263, C3-194264, C3-194393 and C3-194439. |
0.4.0 |
||||
|
2019-11 |
CT3#107 |
Inclusion of C3-195068, C3-195226, C3-195238. |
0.5.0 |
||||
|
2019-12 |
CT#86 |
CP-193178 |
Presented for information |
1.0.0 |
|||
|
2019-12 |
CT#86 |
CP-193295 |
A title corrected |
1.0.1 |
|||
|
2020-02 |
CT3#108e |
Inclusion of C3-201297, C3-201369, C3-201385, C3-201399, C3-201440 and C3-201466. |
1.1.0 |
||||
|
2020-03 |
CT#87e |
CP-200188 |
TS sent to plenary for approval |
2.0.0 |
|||
|
2020-03 |
CT#87e |
CP-200188 |
TS approved by plenary |
16.0.0 |
|||
|
2020-06 |
CT#88e |
CP-201234 |
0001 |
F |
Update service operation for Ue Communication |
16.1.0 |
|
|
2020-06 |
CT#88e |
CP-201234 |
0002 |
F |
Corrections in TS 29.517 |
16.1.0 |
|
|
2020-06 |
CT#88e |
CP-201234 |
0003 |
F |
Definition of AfEventExposureSubsc in OpenAPI |
16.1.0 |
|
|
2020-06 |
CT#88e |
CP-201234 |
0004 |
1 |
D |
Unsubscribe service operation |
16.1.0 |
|
2020-06 |
CT#88e |
CP-201234 |
0005 |
1 |
F |
Correction to event description |
16.1.0 |
|
2020-06 |
CT#88e |
CP-201234 |
0006 |
1 |
F |
Correction to target UE description |
16.1.0 |
|
2020-06 |
CT#88e |
CP-201244 |
0007 |
1 |
F |
Storage of YAML files in ETSI Forge |
16.1.0 |
|
2020-06 |
CT#88e |
CP-201234 |
0008 |
F |
Service operation description for UE mobility |
16.1.0 |
|
|
2020-06 |
CT#88e |
CP-201256 |
0009 |
1 |
F |
URI of the Naf_EventExposure service |
16.1.0 |
|
2020-06 |
CT#88e |
CP-201234 |
0010 |
F |
Support of immediate reporting |
16.1.0 |
|
|
2020-06 |
CT#88e |
CP-201077 |
0012 |
1 |
F |
Supported features definition |
16.1.0 |
|
2020-06 |
CT#88e |
CP-201234 |
0013 |
1 |
F |
Target UE information |
16.1.0 |
|
2020-06 |
CT#88e |
CP-201234 |
0014 |
1 |
F |
Supported headers, Resource Data type and yaml mapping |
16.1.0 |
|
2020-06 |
CT#88e |
CP-201255 |
0015 |
F |
Update of OpenAPI version and TS version in externalDocs field |
16.1.0 |
|
|
2020-09 |
CT#89e |
CP-202066 |
0017 |
1 |
F |
Missed data type definition |
16.2.0 |
|
2020-09 |
CT#89e |
CP-202066 |
0018 |
F |
Corrections on UE Mobility |
16.2.0 |
|
|
2020-09 |
CT#89e |
CP-202066 |
0019 |
F |
Missed response code |
16.2.0 |
|
|
2020-09 |
CT#89e |
CP-202066 |
0020 |
1 |
F |
Any UE indication applies to EXCEPTIONS |
16.2.0 |
|
2020-12 |
CT#90e |
CP-203139 |
0021 |
1 |
F |
Essential Corrections and alignments |
16.3.0 |
|
2020-12 |
CT#90e |
CP-203139 |
0022 |
F |
Storage of YAML files in 3GPP Forge |
16.3.0 |
|
|
2020-12 |
CT#90e |
CP-203129 |
0023 |
1 |
F |
Removal of trailing forward slash in resource URI |
16.3.0 |
|
2020-12 |
CT#90e |
CP-203139 |
0024 |
1 |
F |
Callback URI correction |
16.3.0 |
|
2020-12 |
CT#90e |
CP-203152 |
0027 |
F |
Update of OpenAPI version and TS version in externalDocs field |
16.3.0 |
|
|
2020-12 |
CT#90e |
CP-203130 |
0025 |
1 |
F |
Corrections to location area usage |
17.0.0 |
|
2021-03 |
CT#91e |
CP-210206 |
0029 |
A |
Correction to anyUeInd attribute |
17.1.0 |
|
|
2021-03 |
CT#91e |
CP-210191 |
0031 |
1 |
A |
Support Stateless NFs |
17.1.0 |
|
2021-03 |
CT#91e |
CP-210218 |
0032 |
F |
OpenAPI reference |
17.1.0 |
|
|
2021-03 |
CT#91e |
CP-210219 |
0033 |
F |
Adding some missing description fields to data type definitions in OpenAPI specification files |
17.1.0 |
|
|
2021-03 |
CT#91e |
CP-210220 |
0034 |
F |
Optional header clarification |
17.1.0 |
|
|
2021-03 |
CT#91e |
CP-210206 |
0036 |
F |
Resource URI correction |
17.1.0 |
|
|
2021-03 |
CT#91e |
CP-210240 |
0038 |
F |
Update of OpenAPI version and TS version in externalDocs field |
17.1.0 |
|
|
2021-06 |
CT#92e |
CP-211221 |
0039 |
1 |
B |
Partitioning criteria for applying sampling in specific UE partitions in AF exposure |
17.2.0 |
|
2021-06 |
CT#92e |
CP-211221 |
0040 |
B |
Support of Mute reporting |
17.2.0 |
|
|
2021-06 |
CT#92e |
CP-211200 |
0041 |
1 |
A |
Redirection responses |
17.2.0 |
|
2021-06 |
CT#92e |
CP-211221 |
0043 |
1 |
B |
Extensions to User Data Congestion Analytics |
17.2.0 |
|
2021-06 |
CT#92e |
CP-211265 |
0045 |
F |
Update of OpenAPI version and TS version in externalDocs field |
17.2.0 |
|
|
2021-09 |
CT#93e |
CP-212203 |
0046 |
2 |
B |
Support of Performance Data event |
17.3.0 |
|
2021-09 |
CT#93e |
CP-212220 |
0047 |
F |
Resource URI correction on Naf_EventExposure API |
17.3.0 |
|
|
2021-09 |
CT#93e |
CP-212203 |
0048 |
1 |
B |
Collective Behaviour analytics |
17.3.0 |
|
2021-09 |
CT#93e |
CP-212203 |
0049 |
2 |
B |
Support UE data volume dispersion collection |
17.3.0 |
|
2021-09 |
CT#93e |
CP-212223 |
0050 |
F |
Update of OpenAPI version and TS version in externalDocs field |
17.3.0 |
|
|
2021-12 |
CT#94e |
CP-213227 |
0052 |
1 |
B |
Updates to UE data volume dispersion collection |
17.4.0 |
|
2021-12 |
CT#94e |
CP-213256 |
0055 |
B |
Collective Behaviour Analytics update |
17.4.0 |
|
|
2021-12 |
CT#94e |
CP-213227 |
0051 |
1 |
F |
Updates to User Data Congestion |
17.4.0 |
|
2021-12 |
CT#94e |
CP-213227 |
0053 |
F |
Adding collective behaviour analytics feature |
17.4.0 |
|
|
2021-12 |
CT#94e |
CP-213227 |
0054 |
2 |
F |
Update of notification procedure with description of USER_DATA_CONGESTION and DISPERSION events |
17.4.0 |
|
2021-12 |
CT#94e |
CP-213220 |
0056 |
B |
Alignment with SA3 supported TLS profiles |
17.4.0 |
|
|
2021-12 |
CT#94e |
0057 |
F |
Update of OpenAPI version and TS version in externalDocs field |
17.4.0 |
||
|
2022-03 |
CT#95e |
CP-220190 |
0058 |
1 |
B |
Update UE Application collective behaviour for NF Load analytics |
17.5.0 |
|
2022-03 |
CT#95e |
CP-220190 |
0059 |
1 |
F |
type attribute in CollectiveBehaviourFilter data type |
17.5.0 |
|
2022-03 |
CT#95e |
CP-220190 |
0060 |
1 |
F |
Miscellaneous corrections |
17.5.0 |
|
2022-03 |
CT#95e |
CP-220191 |
0062 |
1 |
F |
Formatting of description fields |
17.5.0 |
|
2022-03 |
CT#95e |
CP-220201 |
0061 |
1 |
F |
Corrections to Data Model of AF Event Exposure service |
17.5.0 |
|
2022-03 |
CT#95e |
CP-220194 |
0063 |
F |
Update of info and externalDocs field |
17.5.0 |
|
|
2022-06 |
CT#96 |
CP-221131 |
0064 |
1 |
B |
Add Application duration for Dispersion |
17.6.0 |
|
2022-06 |
CT#96 |
CP-221131 |
0065 |
1 |
B |
Add Application Server Instance for Service Experience |
17.6.0 |
|
2022-06 |
CT#96 |
CP-221155 |
0068 |
1 |
F |
Remove the apiVersion placeholder from the resource URI variables table |
17.6.0 |
|
2022-06 |
CT#96 |
CP-221133 |
0066 |
– |
F |
Muting notifications correction |
17.6.0 |
|
2022-06 |
CT#96 |
CP-221134 |
0067 |
– |
F |
Presence condition on the data types of Naf_EventExposure service |
17.6.0 |
|
2022-06 |
CT#96 |
CP-221142 |
0069 |
1 |
B |
Support UE Application event exposure via Data Collection AF |
17.6.0 |
|
2022-06 |
CT#96 |
CP-221296 |
0070 |
1 |
B |
Support QoE metrics in AF Event Exposure |
17.6.0 |
|
2022-06 |
CT#96 |
CP-221142 |
0071 |
1 |
B |
Support Consumption reports in AF Event Exposure |
17.6.0 |
|
2022-06 |
CT#96 |
CP-221142 |
0072 |
1 |
B |
Support Network Assistance invocations in AF Event Exposure |
17.6.0 |
|
2022-06 |
CT#96 |
CP-221142 |
0073 |
1 |
B |
Support Charging and Policy invocations in AF Event Exposure |
17.6.0 |
|
2022-06 |
CT#96 |
CP-221142 |
0074 |
1 |
B |
Support Media Streaming access activity in AF Event Exposure |
17.6.0 |
|
2022-06 |
CT#96 |
CP-221151 |
0075 |
– |
F |
Update of info and externalDocs fields |
17.6.0 |
|
2022-09 |
CT#97e |
CP-222101 |
0083 |
– |
F |
clarification on dataUsage in DispersionCollection |
17.7.0 |
|
2022-09 |
CT#97e |
CP-222103 |
0084 |
1 |
F |
Add NOTE for 3xx response codes |
17.7.0 |
|
2022-09 |
CT#97e |
CP-222102 |
0085 |
1 |
F |
Missing description field for enumeration data types |
17.7.0 |
|
2022-09 |
CT#97e |
CP-222103 |
0082 |
1 |
F |
Correcting the events to which certain event consumers can subscribe |
17.7.0 |
|
2022-09 |
CT#97e |
CP-222110 |
0076 |
1 |
B |
Updates to Media Streaming QoE metrics Event |
17.7.0 |
|
2022-09 |
CT#97e |
CP-222110 |
0077 |
1 |
F |
Updates to Media Streaming Consumption Event |
17.7.0 |
|
2022-09 |
CT#97e |
CP-222110 |
0078 |
1 |
F |
Updates to Media Streaming Network Assistance Invocation Event |
17.7.0 |
|
2022-09 |
CT#97e |
CP-222110 |
0079 |
1 |
F |
Updates to Media Streaming Dynamic Policy Invocation Event |
17.7.0 |
|
2022-09 |
CT#97e |
CP-222110 |
0080 |
1 |
F |
Updates to Media Streaming Access Event |
17.7.0 |
|
2022-09 |
CT#97e |
CP-222121 |
0086 |
– |
F |
Update of info and externalDocs fields |
17.7.0 |
|
2022-12 |
CT#98e |
C3-225534 |
0088 |
1 |
F |
Corrections to procedures of MS Event Exposure |
17.8.0 |
|
2022-12 |
CT#98e |
CP-223191 |
0087 |
– |
F |
Adding the mandatory error code 502 Bad Gateway |
18.0.0 |
|
2022-12 |
CT#98e |
CP-223176 |
0089 |
1 |
F |
Corrections to UE Mobility event |
18.0.0 |
|
2022-12 |
CT#98e |
CP-223176 |
0090 |
1 |
F |
Correct the name of the data structure |
18.0.0 |
|
2022-12 |
CT#98e |
CP-223189 |
0091 |
– |
F |
Update of info and externalDocs fields |
18.0.0 |