A.2 Nsmf_EventExposure API

29.5083GPP5G SystemRelease 18Session Management Event Exposure ServiceStage 3TS

openapi: 3.0.0

info:

version: 1.3.0-alpha.1

title: Nsmf_EventExposure

description: |

Session Management Event Exposure Service.

© 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).

All rights reserved.

externalDocs:

description: 3GPP TS 29.508 V18.0.0; 5G System; Session Management Event Exposure Service.

url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.508/

servers:

– url: ‘{apiRoot}/nsmf-event-exposure/v1’

variables:

apiRoot:

default: https://example.com

description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501

security:

– {}

– oAuth2ClientCredentials:

– nsmf-event-exposure

paths:

/subscriptions:

post:

operationId: CreateIndividualSubcription

summary: Create an individual subscription for event notifications from the SMF

tags:

– Subscriptions (Collection)

requestBody:

required: true

content:

application/json:

schema:

$ref: ‘#/components/schemas/NsmfEventExposure’

responses:

‘201’:

description: Created.

headers:

Location:

description: >

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

{apiRoot}/nsmf-event-exposure/v1/subscriptions/{subId}

required: true

schema:

type: string

content:

application/json:

schema:

$ref: ‘#/components/schemas/NsmfEventExposure’

‘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:

myNotification:

‘{$request.body#/notifUri}’:

post:

requestBody:

required: true

content:

application/json:

schema:

$ref: ‘#/components/schemas/NsmfEventExposureNotification’

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’

callbacks:

afAcknowledgement:

‘{request.body#/ackUri}’:

post:

requestBody: # contents of the callback message

required: true

content:

application/json:

schema:

$ref: ‘#/components/schemas/AckOfNotify’

responses:

‘204’:

description: No Content (successful acknowledgement)

‘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/{subId}:

get:

operationId: GetIndividualSubcription

summary: Read an individual subscription for event notifications from the SMF

tags:

– IndividualSubscription (Document)

parameters:

– name: subId

in: path

description: Event Subscription ID

required: true

schema:

type: string

responses:

‘200’:

description: OK. Resource representation is returned

content:

application/json:

schema:

$ref: ‘#/components/schemas/NsmfEventExposure’

‘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:

operationId: ReplaceIndividualSubcription

summary: Replace an individual subscription for event notifications from the SMF

tags:

– IndividualSubscription (Document)

requestBody:

required: true

content:

application/json:

schema:

$ref: ‘#/components/schemas/NsmfEventExposure’

parameters:

– name: subId

in: path

description: 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/NsmfEventExposure’

‘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:

operationId: DeleteIndividualSubcription

summary: Delete an individual subscription for event notifications from the SMF

tags:

– IndividualSubscription (Document)

parameters:

– name: subId

in: path

description: 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: ‘{nrfApiRoot}/oauth2/token’

scopes:

nsmf-event-exposure: Access to the Nsmf_EventExposure API

schemas:

NsmfEventExposure:

description: >

Represents an Individual SMF Notification Subscription resource. The serviveName property

corresponds to the serviceName in the main body of the specification.

type: object

properties:

supi:

$ref: ‘TS29571_CommonData.yaml#/components/schemas/Supi’

gpsi:

$ref: ‘TS29571_CommonData.yaml#/components/schemas/Gpsi’

anyUeInd:

type: boolean

description: >

Any UE indication. This IE shall be present if the event subscription is applicable to

any UE. Default value "false" is used, if not present.

groupId:

$ref: ‘TS29571_CommonData.yaml#/components/schemas/GroupId’

pduSeId:

$ref: ‘TS29571_CommonData.yaml#/components/schemas/PduSessionId’

dnn:

$ref: ‘TS29571_CommonData.yaml#/components/schemas/Dnn’

snssai:

$ref: ‘TS29571_CommonData.yaml#/components/schemas/Snssai’

subId:

$ref: ‘#/components/schemas/SubId’

notifId:

type: string

description: Notification Correlation ID assigned by the NF service consumer.

notifUri:

$ref: ‘TS29571_CommonData.yaml#/components/schemas/Uri’

altNotifIpv4Addrs:

type: array

items:

$ref: ‘TS29571_CommonData.yaml#/components/schemas/Ipv4Addr’

description: Alternate or backup IPv4 address(es) where to send Notifications.

minItems: 1

altNotifIpv6Addrs:

type: array

items:

$ref: ‘TS29571_CommonData.yaml#/components/schemas/Ipv6Addr’

description: Alternate or backup IPv6 address(es) where to send Notifications.

minItems: 1

altNotifFqdns:

type: array

items:

$ref: ‘TS29571_CommonData.yaml#/components/schemas/Fqdn’

minItems: 1

description: Alternate or backup FQDN(s) where to send Notifications.

eventSubs:

type: array

items:

$ref: ‘#/components/schemas/EventSubscription’

minItems: 1

description: Subscribed events

eventNotifs:

type: array

items:

$ref: ‘#/components/schemas/EventNotification’

minItems: 1

ImmeRep:

type: boolean

notifMethod:

$ref: ‘#/components/schemas/NotificationMethod’

maxReportNbr:

$ref: ‘TS29571_CommonData.yaml#/components/schemas/Uinteger’

expiry:

$ref: ‘TS29571_CommonData.yaml#/components/schemas/DateTime’

repPeriod:

$ref: ‘TS29571_CommonData.yaml#/components/schemas/DurationSec’

guami:

$ref: ‘TS29571_CommonData.yaml#/components/schemas/Guami’

serviveName:

$ref: ‘TS29510_Nnrf_NFManagement.yaml#/components/schemas/ServiceName’

supportedFeatures:

$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’

sampRatio:

$ref: ‘TS29571_CommonData.yaml#/components/schemas/SamplingRatio’

partitionCriteria:

type: array

items:

$ref: ‘TS29571_CommonData.yaml#/components/schemas/PartitioningCriteria’

minItems: 1

description: Criteria for partitioning the UEs before applying the sampling ratio.

grpRepTime:

$ref: ‘TS29571_CommonData.yaml#/components/schemas/DurationSec’

notifFlag:

$ref: ‘TS29571_CommonData.yaml#/components/schemas/NotificationFlag’

required:

– notifId

– notifUri

– eventSubs

NsmfEventExposureNotification:

description: Represents notifications on events that occurred.

type: object

properties:

notifId:

type: string

description: Notification correlation ID

eventNotifs:

type: array

items:

$ref: ‘#/components/schemas/EventNotification’

minItems: 1

description: Notifications about Individual Events

ackUri:

$ref: ‘TS29571_CommonData.yaml#/components/schemas/Uri’

required:

– notifId

– eventNotifs

EventSubscription:

description: Represents a subscription to a single event.

type: object

properties:

event:

$ref: ‘#/components/schemas/SmfEvent’

dnaiChgType:

$ref: ‘TS29571_CommonData.yaml#/components/schemas/DnaiChangeType’

dddTraDescriptors:

type: array

items:

$ref: ‘TS29571_CommonData.yaml#/components/schemas/DddTrafficDescriptor’

minItems: 1

dddStati:

type: array

items:

$ref: ‘TS29571_CommonData.yaml#/components/schemas/DlDataDeliveryStatus’

minItems: 1

appIds:

type: array

items:

$ref: ‘TS29571_CommonData.yaml#/components/schemas/ApplicationId’

minItems: 1

targetPeriod:

$ref: ‘TS29122_CommonData.yaml#/components/schemas/TimeWindow’

transacDispInd:

type: boolean

description: >

Indicates the subscription for UE transaction dispersion collectionon, if it is included

and set to "true". Default value is "false".

transacMetrics:

type: array

items:

$ref: ‘#/components/schemas/TransactionMetric’

description: Indicates Session Management Transaction metrics.

minItems: 1

ueIpAddr:

$ref: ‘TS29571_CommonData.yaml#/components/schemas/IpAddr’

required:

– event

EventNotification:

description: Represents a notification related to a single event that occurred.

type: object

properties:

event:

$ref: ‘#/components/schemas/SmfEvent’

timeStamp:

$ref: ‘TS29571_CommonData.yaml#/components/schemas/DateTime’

supi:

$ref: ‘TS29571_CommonData.yaml#/components/schemas/Supi’

gpsi:

$ref: ‘TS29571_CommonData.yaml#/components/schemas/Gpsi’

ueIpAddr:

$ref: ‘TS29571_CommonData.yaml#/components/schemas/IpAddr’

transacInfos:

type: array

items:

$ref: ‘#/components/schemas/TransactionInfo’

description: Transaction Information.

minItems: 1

sourceDnai:

$ref: ‘TS29571_CommonData.yaml#/components/schemas/Dnai’

targetDnai:

$ref: ‘TS29571_CommonData.yaml#/components/schemas/Dnai’

dnaiChgType:

$ref: ‘TS29571_CommonData.yaml#/components/schemas/DnaiChangeType’

sourceUeIpv4Addr:

$ref: ‘TS29571_CommonData.yaml#/components/schemas/Ipv4Addr’

sourceUeIpv6Prefix:

$ref: ‘TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix’

targetUeIpv4Addr:

$ref: ‘TS29571_CommonData.yaml#/components/schemas/Ipv4Addr’

targetUeIpv6Prefix:

$ref: ‘TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix’

sourceTraRouting:

$ref: ‘TS29571_CommonData.yaml#/components/schemas/RouteToLocation’

targetTraRouting:

$ref: ‘TS29571_CommonData.yaml#/components/schemas/RouteToLocation’

ueMac:

$ref: ‘TS29571_CommonData.yaml#/components/schemas/MacAddr48’

adIpv4Addr:

$ref: ‘TS29571_CommonData.yaml#/components/schemas/Ipv4Addr’

adIpv6Prefix:

$ref: ‘TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix’

reIpv4Addr:

$ref: ‘TS29571_CommonData.yaml#/components/schemas/Ipv4Addr’

reIpv6Prefix:

$ref: ‘TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix’

plmnId:

$ref: ‘TS29571_CommonData.yaml#/components/schemas/PlmnId’

accType:

$ref: ‘TS29571_CommonData.yaml#/components/schemas/AccessType’

pduSeId:

$ref: ‘TS29571_CommonData.yaml#/components/schemas/PduSessionId’

ratType:

$ref: ‘TS29571_CommonData.yaml#/components/schemas/RatType’

dddStatus:

$ref: ‘TS29571_CommonData.yaml#/components/schemas/DlDataDeliveryStatus’

dddTraDescriptor:

$ref: ‘TS29571_CommonData.yaml#/components/schemas/DddTrafficDescriptor’

maxWaitTime:

$ref: ‘TS29571_CommonData.yaml#/components/schemas/DateTime’

commFailure:

$ref: ‘TS29518_Namf_EventExposure.yaml#/components/schemas/CommunicationFailure’

ipv4Addr:

$ref: ‘TS29571_CommonData.yaml#/components/schemas/Ipv4Addr’

ipv6Prefixes:

type: array

items:

$ref: ‘TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix’

minItems: 1

ipv6Addrs:

type: array

items:

$ref: ‘TS29571_CommonData.yaml#/components/schemas/Ipv6Addr’

minItems: 1

pduSessType:

$ref: ‘TS29571_CommonData.yaml#/components/schemas/PduSessionType’

qfi:

$ref: ‘TS29571_CommonData.yaml#/components/schemas/Qfi’

appId:

$ref: ‘TS29571_CommonData.yaml#/components/schemas/ApplicationId’

ethFlowDescs:

type: array

items:

$ref: ‘TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/EthFlowDescription’

minItems: 1

description: >

Descriptor(s) for non-IP traffic. It allows the encoding of multiple UL and/or DL flows.

Each entry of the array describes a single Ethernet flow.

ethfDescs:

type: array

items:

$ref: ‘TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/EthFlowDescription’

minItems: 1

maxItems: 2

description: >

Contains the UL and/or DL Ethernet flows. Each entry of the array describes a single

Ethernet flow.

flowDescs:

type: array

items:

$ref: ‘TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/FlowDescription’

minItems: 1

description: >

Descriptor(s) for IP traffic. It allows the encoding of multiple UL and/or DL flows.

Each entry of the array describes a single IP flow.

fDescs:

type: array

items:

$ref: ‘TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/FlowDescription’

minItems: 1

maxItems: 2

description: >

Contains the UL and/or DL IP flows. Each entry of the array describes a single

IP flow.

dnn:

$ref: ‘TS29571_CommonData.yaml#/components/schemas/Dnn’

snssai:

$ref: ‘TS29571_CommonData.yaml#/components/schemas/Snssai’

ulDelays:

type: array

items:

$ref: ‘TS29571_CommonData.yaml#/components/schemas/Uinteger’

minItems: 1

dlDelays:

type: array

items:

$ref: ‘TS29571_CommonData.yaml#/components/schemas/Uinteger’

minItems: 1

rtDelays:

type: array

items:

$ref: ‘TS29571_CommonData.yaml#/components/schemas/Uinteger’

minItems: 1

timeWindow:

$ref: ‘TS29122_CommonData.yaml#/components/schemas/TimeWindow’

smNasFromUe:

$ref: ‘#/components/schemas/SmNasFromUe’

smNasFromSmf:

$ref: ‘#/components/schemas/SmNasFromSmf’

upRedTrans:

type: boolean

description: >

Indicates whether the redundant transmission is setup or terminated. Set to "true" if

the redundant transmission is setup, otherwise set to "false" if the redundant

transmission is terminated. Default value is set to "false".

ssId:

type: string

bssId:

type: string

startWlan:

$ref: ‘TS29571_CommonData.yaml#/components/schemas/DateTime’

endWlan:

$ref: ‘TS29571_CommonData.yaml#/components/schemas/DateTime’

pduSessInfos:

type: array

items:

$ref: ‘#/components/schemas/PduSessionInformation’

minItems: 1

upfInfo:

$ref: ‘#/components/schemas/UpfInformation’

required:

– event

– timeStamp

SubId:

type: string

format: SubId

description: >

Identifies an Individual SMF Notification Subscription. To enable that the value is used as

part of a URI, the string shall only contain characters allowed according to the

"lower-with-hyphen" naming convention defined in 3GPP TS 29.501. In an OpenAPI schema, the

format shall be designated as "SubId".

AckOfNotify:

description: Represents an acknowledgement information of an event notification.

type: object

properties:

notifId:

type: string

ackResult:

$ref: ‘TS29522_TrafficInfluence.yaml#/components/schemas/AfResultInfo’

supi:

$ref: ‘TS29571_CommonData.yaml#/components/schemas/Supi’

gpsi:

$ref: ‘TS29571_CommonData.yaml#/components/schemas/Gpsi’

required:

– notifId

– ackResult

SmNasFromUe:

description: >

Represents information on the SM NAS messages that SMF receives from UE for PDU Session.

type: object

properties:

smNasType:

type: string

timeStamp:

$ref: ‘TS29571_CommonData.yaml#/components/schemas/DateTime’

required:

– smNasType

– timeStamp

SmNasFromSmf:

description: >

Represents information on the SM congestion control applied SM NAS messages that SMF sends

to UE for PDU Session.

type: object

properties:

smNasType:

type: string

timeStamp:

$ref: ‘TS29571_CommonData.yaml#/components/schemas/DateTime’

backoffTimer:

$ref: ‘TS29571_CommonData.yaml#/components/schemas/DurationSec’

appliedSmccType:

$ref: ‘#/components/schemas/AppliedSmccType’

required:

– smNasType

– timeStamp

– backoffTimer

– appliedSmccType

TransactionInfo:

description: Represents SMF Transaction Information.

type: object

properties:

transaction:

$ref: ‘TS29571_CommonData.yaml#/components/schemas/Uinteger’

snssai:

$ref: ‘TS29571_CommonData.yaml#/components/schemas/Snssai’

appIds:

type: array

items:

$ref: ‘TS29571_CommonData.yaml#/components/schemas/ApplicationId’

minItems: 1

transacMetrics:

type: array

items:

$ref: ‘#/components/schemas/TransactionMetric’

minItems: 1

required:

– transaction

PduSessionInformation:

description: Represents the PDU session related information.

type: object

properties:

pduSessId:

$ref: ‘TS29571_CommonData.yaml#/components/schemas/PduSessionId’

sessInfo:

$ref: ‘#/components/schemas/PduSessionInfo’

PduSessionInfo:

description: Represents session information.

type: object

properties:

n4SessId:

type: string

description: The identifier of the N4 session for the reported PDU Session.

sessInactiveTimer:

$ref: ‘TS29571_CommonData.yaml#/components/schemas/DurationSec’

pduSessStatus:

$ref: ‘#/components/schemas/PduSessionStatus’

UpfInformation:

description: Represents the ID/address/FQDN of the UPF.

type: object

properties:

upfId:

type: string

upfAddr:

$ref: ‘TS29517_Naf_EventExposure.yaml#/components/schemas/AddrFqdn’

SmfEvent:

anyOf:

– type: string

enum:

– AC_TY_CH

– UP_PATH_CH

– PDU_SES_REL

– PLMN_CH

– UE_IP_CH

– RAT_TY_CH

– DDDS

– COMM_FAIL

– PDU_SES_EST

– QFI_ALLOC

– QOS_MON

– SMCC_EXP

– DISPERSION

– RED_TRANS_EXP

– WLAN_INFO

– UPF_INFO

– UP_STATUS_INFO

– type: string

description: >

This string provides forward-compatibility with future

extensions to the enumeration and is not used to encode

content defined in the present version of this API.

description: |

Possible values are:

– AC_TY_CH: Access Type Change

– UP_PATH_CH: UP Path Change

– PDU_SES_REL: PDU Session Release

– PLMN_CH: PLMN Change

– UE_IP_CH: UE IP address change

– RAT_TY_CH: RAT Type Change

– DDDS: Downlink data delivery status

– COMM_FAIL: Communication Failure

– PDU_SES_EST: PDU Session Establishment

– QFI_ALLOC: QFI allocation

– QOS_MON: QoS Monitoring

– SMCC_EXP: SM congestion control experience for PDU Session

– DISPERSION: Session Management transaction dispersion

– RED_TRANS_EXP: Redundant transmission experience for PDU Session

– WLAN_INFO: WLAN information on PDU session for which Access Type is NON_3GPP_ACCESS and

RAT Type is TRUSTED_WLAN

– UPF_INFO: The UPF information, including the UPF ID/address/FQDN information.

– UP_STATUS_INFO: The User Plane status information.

NotificationMethod:

anyOf:

– type: string

enum:

– PERIODIC

– ONE_TIME

– ON_EVENT_DETECTION

– type: string

description: >

This string provides forward-compatibility with future

extensions to the enumeration and is not used to encode

content defined in the present version of this API.

description: |

Possible values are:

– PERIODIC

– ONE_TIME

– ON_EVENT_DETECTION

AppliedSmccType:

anyOf:

– type: string

enum:

– DNN_CC

– SNSSAI_CC

description: >

This string indicates the type of applied SM congestion control.

– type: string

description: >

This string provides forward-compatibility with future

extensions to the enumeration and is not used to encode

content defined in the present version of this API.

description: |

Possible values are:

– DNN_CC: Indicates the DNN based congestion control.

– SNSSAI_CC: Indicates the S-NSSAI based congestion control.

TransactionMetric:

anyOf:

– type: string

enum:

– PDU_SES_EST

– PDU_SES_AUTH

– PDU_SES_MODIF

– PDU_SES_REL

– type: string

description: >

This string provides forward-compatibility with future extensions to the enumeration

and is not used to encode content defined in the present version of this API.

description: |

Possible values are:

– PDU_SES_EST: PDU Session Establishment

– PDU_SES_AUTH: PDU Session Authentication

– PDU_SES_MODIF: PDU Session Modification

– PDU_SES_REL: PDU Session Release

PduSessionStatus:

anyOf:

– type: string

enum:

– ACTIVATED

– DEACTIVATED

– type: string

description: >

This string provides forward-compatibility with future extensions to the enumeration

and is not used to encode content defined in the present version of this API.

description: |

Possible values are:

– ACTIVATED: PDU Session status is activated.

– DEACTIVATED: PDU Session status is deactivated.

Annex B (informative):
Change history

Change history

Date

TSG #

TSG Doc.

CR

Rev

Cat

Subject/Comment

New

2017-10

TS skeleton of Session Management Event Exposure Service specification

0.0.0

2017-10

CT3#92

C3-175326,C3-175327 and C3-175281

0.1.0

2017-12

CT3#93

C3-176071, C3-176240, C3-176316, C3-176242, C3-176243, C3-176244, C3-176317 and C3-176318

0.2.0

2018-01

CT3#94

C3-180034, C3-180196 and C3-180197

0.3.0

2018-03

CT3#95

C3-181366

Inclusion of P-CRs agreed in CT3#95:

C3-181214, C3-181215, C3-181216, C3-181217, C3-181354, C3-181353.

0.4.0

2018-04

CT3#96

C3-182315, C3-182316, C3-182144, C3-182317

0.5.0

2018-05

CT3#97

C3-183452, C3-183451, C3-183829, C3-183453, C3-183454, C3-183283 and C3-183455.

0.6.0

2018-06

CT#80

CP-181039

TS sent to plenary for approval

1.0.0

2018-06

CT#80

CP-181039

TS approved by plenary

15.0.0

2018-09

CT#81

CP-182015

0001

2

F

DNAI change notification type

15.1.0

2018-09

CT#81

CP-182015

0002

4

F

Completion of Error Codes in OpenAPI file

15.1.0

2018-09

CT#81

CP-182015

0003

F

Definition of DNAI

15.1.0

2018-09

CT#81

CP-182015

0004

2

F

Stateless AMF support updates

15.1.0

2018-09

CT#81

CP-182015

0007

1

F

Encoding of the "N6 traffic routing information"

15.1.0

2018-09

CT#81

CP-182033

0008

2

F

Addition of Time Stamp

15.1.0

2018-09

CT#81

CP-182015

0009

1

F

Update of resource figure

15.1.0

2018-09

CT#81

CP-182015

0010

F

Update of resource figure

15.1.0

2018-12

CT#82

CP-183205

0011

6

F

Correction to the event subscription

15.2.0

2018-12

CT#82

CP-183205

0012

4

F

Correction to the AF influence traffic steering control

15.2.0

2018-12

CT#82

CP-183137

0013

5

F

Immediate reporting flag

15.2.0

2018-12

CT#82

CP-183205

0014

2

F

UE ID in the notification

15.2.0

2018-12

CT#82

CP-183205

0015

1

F

Correction to the overview

15.2.0

2018-12

CT#82

CP-183205

0016

2

F

Correction to the NF consumer

15.2.0

2018-12

CT#82

CP-183205

0017

1

F

Location Header

15.2.0

2018-12

CT#82

CP-183205

0018

F

Data for notification

15.2.0

2018-12

CT#82

CP-183205

0019

1

F

NotificationMethod

15.2.0

2018-12

CT#82

CP-183205

0020

1

F

Correction of apiName

15.2.0

2018-12

CT#82

CP-183205

0021

F

Default value for apiRoot

15.2.0

2018-12

CT#82

CP-183205

0023

F

API version

15.2.0

2018-12

CT#82

CP-183205

0024

1

F

ExternalDocs OpenAPI field

15.2.0

2018-12

CT#82

CP-183205

0025

F

Location header field in OpenAPI

15.2.0

2018-12

CT#82

CP-183205

0026

1

F

Security

15.2.0

2018-12

CT#82

CP-183205

0027

F

supported content types

15.2.0

2018-12

CT#82

CP-183205

0028

2

F

HTTP Error responses

15.2.0

2018-12

CT#82

CP-183205

0029

1

F

Monitoring identities

15.2.0

2018-12

CT#82

CP-183205

0030

F

Correction to the names of data types

15.2.0

2018-12

CT#82

CP-183205

0031

F

Report of Ethernet UE address

15.2.0

2019-03

CT#83

CP-190117

0032

1

F

Correction of name of security scope

15.3.0

2019-03

CT#83

CP-190117

0033

2

F

API version update for Rel-15

15.3.0

2019-03

CT#83

CP-190117

0034

1

F

Correction of URIs in resource structure table and figure

15.3.0

2019-06

CT#84

CP-191074

0037

3

F

Correct condition for DNAI in UP path change

15.4.0

2019-06

CT#84

CP-191074

0038

1

F

Precedence of OpenAPI file

15.4.0

2019-06

CT#84

CP-191074

0041

1

F

Correction of Misplaced Location header in OpenAPI file

15.4.0

2019-06

CT#84

CP-191074

0043

2

F

API version Update

15.4.0

2019-06

CT#84

CP-191074

0044

1

F

Copyright Note in YAML file

15.4.0

2019-06

CT#84

CP-191070

0039

3

B

Downlink data delivery status event

16.0.0

2019-06

CT#84

CP-191071

0040

3

B

AF acknowledgement of UP path event notification

16.0.0

2019-06

CT#84

CP-191101

0042

2

F

API version Update

16.0.0

2019-09

CT#85

CP-192169

0045

B

Add communication failure event

16.1.0

2019-09

CT#85

CP-192141

0046

1

A

Correct SMF event exposure service name

16.1.0

2019-09

CT#85

CP-192157

0047

1

B

Enhancement of event reporting information

16.1.0

2019-09

CT#85

CP-192157

0048

2

B

Support for Service Experience

16.1.0

2019-09

CT#85

CP-192159

0049

1

B

I-SMF notification to SMF

16.1.0

2019-09

CT#85

CP-192220

0050

3

B

Notification of downlink data delivery status

16.1.0

2019-09

CT#85

CP-192138

0051

2

B

AF acknowledgement of UP path event notification

16.1.0

2019-09

CT#85

CP-192173

0054

F

OpenAPI version update for TS 29.508 Rel-16

16.1.0

2019-12

CT#86

CP-193183

0056

A

Usage of the "serviveName" attribute

16.2.0

2019-12

CT#86

CP-193197

0057

F

Data type of the "serviceName" attribute

16.2.0

2019-12

CT#86

CP-193181

0058

1

B

OpenAPI file update to support AF acknowledgement

16.2.0

2019-12

CT#86

CP-193181

0059

3

F

Update of AFRelocationAck feature

16.2.0

2019-12

CT#86

CP-193201

0060

1

B

I-SMF applicable event

16.2.0

2019-12

CT#86

CP-193183

0062

1

A

Correction on 307 error, 29.508

16.2.0

2019-12

CT#86

CP-193212

0064

F

Update of API version and TS version in OpenAPI file

16.2.0

2020-03

CT#87e

CP-200220

0065

1

B

Update of the Availability after DDN Failure event

16.3.0

2020-03

CT#87e

CP-200230

0066

1

B

Update of the DDD status event

16.3.0

2020-03

CT#87e

CP-200202

0067

1

B

QoS Monitoring Report

16.3.0

2020-03

CT#87e

CP-200198

0068

B

Support PDU session establishment event

16.3.0

2020-03

CT#87e

CP-200198

0070

F

V-SMF applicable event

16.3.0

2020-03

CT#87e

CP-200241

0071

2

B

QFI allocation event

16.3.0

2020-03

CT#87e

CP-200211

0072

F

DDD status for I-SMF

16.3.0

2020-03

CT#87e

CP-200216

0073

F

Update of OpenAPI version and TS version in externalDocs field

16.3.0

2020-06

CT#88e

CP-201210

0075

1

F

Correction to the DDD status event

16.4.0

2020-06

CT#88e

CP-201246

0077

1

F

Correct presence condition in event subscription

16.4.0

2020-06

CT#88e

CP-201244

0078

1

F

Storage of YAML files in ETSI Forge

16.4.0

2020-06

CT#88e

CP-201210

0079

F

Monitoring event normalization in roaming case

16.4.0

2020-06

CT#88e

CP-201256

0080

1

F

URI of the Nsmf_EventExposure service

16.4.0

2020-06

CT#88e

CP-201213

0081

1

F

Correction to QoS Monitoring report

16.4.0

2020-06

CT#88e

CP-201216

0083

A

Notification Uri and subId resource URI

16.4.0

2020-06

CT#88e

CP-201216

0085

1

A

OpenAPI: adding Location header field in 307 response

16.4.0

2020-06

CT#88e

CP-201233

0086

1

B

FQDN of alternate or backup AMF

16.4.0

2020-06

CT#88e

CP-201210

0087

B

Add DNN and Slice filter

16.4.0

2020-06

CT#88e

CP-201210

0088

F

Correct presence condition for snssai

16.4.0

2020-06

CT#88e

CP-201213

0089

1

F

Add missing event

16.4.0

2020-06

CT#88e

CP-201244

0092

F

Optionality of ProblemDetails

16.4.0

2020-06

CT#88e

CP-201244

0093

1

F

Supported headers, Resource Data type, Operation Name

16.4.0

2020-06

CT#88e

CP-201255

0095

F

Update of OpenAPI version and TS version in externalDocs field

16.4.0

2020-09

CT#89e

CP-202050

0096

1

F

notifId used for QoS monitoring report

16.5.0

2020-09

CT#89e

CP-202048

0097

F

Correction to detection of downlink data delivery status change

16.5.0

2020-09

CT#89e

CP-202067

0100

F

Remove UP path change for I-SMF

16.5.0

2020-09

CT#89e

CP-202209

0101

1

F

Subscribed delivery status

16.5.0

2020-09

CT#89e

CP-202073

0098

F

Successful status code

17.0.0

2020-12

CT#90e

CP-203139

0103

1

A

Essential corrections and alignments

17.1.0

2020-12

CT#90e

CP-203139

0105

1

A

Storage of YAML files in 3GPP Forge

17.1.0

2020-12

CT#90e

CP-203108

0107

A

Correction to ddd status when the SMF buffers the data

17.1.0

2020-12

CT#90e

CP-203113

0110

1

A

Corrections on resourceURI

17.1.0

2020-12

CT#90e

CP-203108

0112

1

A

notifId provided by the UDM for CIoT events

17.1.0

2021-03

CT#91e

CP-210191

0115

1

A

Support of stateless NFs

17.2.0

2021-03

CT#91e

CP-210218

0118

F

OpenAPI reference

17.2.0

2021-03

CT#91e

CP-210219

0119

F

Clarification on optional HTTP custom headers

17.2.0

2021-03

CT#91e

CP-210189

0121

1

A

Correction to DDD status event detection

17.2.0

2021-03

CT#91e

CP-210189

0123

A

Correction to DDD status event subscription

17.2.0

2021-03

CT#91e

CP-210221

0124

1

F

Ambiguous concept of NF service consumer terminology

17.2.0

2021-03

CT#91e

CP-210219

0125

1

F

Adding some missing description fields to data type definitions in OpenAPI specification files

17.2.0

2021-03

CT#91e

CP-210194

0128

A

alignment of dnaiChgType attribute

17.2.0

2021-03

CT#91e

CP-210240

0130

F

Update of OpenAPI version and TS version in externalDocs field

17.2.0

2021-06

CT#92e

CP-211221

0131

2

B

Partitioning criteria for applying sampling in specific UE partitions in SMF exposure

17.3.0

2021-06

CT#92e

CP-211221

0132

1

B

Support of Mute Reporting

17.3.0

2021-06

CT#92e

CP-211200

0134

1

A

Temporary and Permanent Redirection

17.3.0

2021-06

CT#92e

CP-211243

0135

1

F

Removal of resource URI in Notification Acknowledgement procedure

17.3.0

2021-06

CT#92e

CP-211221

0136

1

B

Nsmf_EventExposure supports RAT Type Change Event

17.3.0

2021-06

CT#92e

CP-211265

0138

F

Update of OpenAPI version and TS version in externalDocs field

17.3.0

2021-09

CT#93e

CP-212220

0139

1

F

Correction of URI structure

17.4.0

2021-09

CT#93e

CP-212221

0141

1

A

Missing PDU Session ID from QFI allocation event notifications

17.4.0

2021-09

CT#93e

CP-212198

0142

2

B

Adding uplink buffering indication for Application Relocation

17.4.0

2021-09

CT#93e

CP-212203

0143

1

F

Corrections for RAT Type exposure

17.4.0

2021-09

CT#93e

CP-212223

0144

F

Update of OpenAPI version and TS version in externalDocs field

17.4.0

2021-12

CT#94e

CP-213227

0145

1

B

Update input data collection for Slice load level information

17.5.0

2021-12

CT#94e

CP-213228

0146

2

B

New event for SM congestion control experience

17.5.0

2021-12

CT#94e

CP-213238

0148

A

The <apiName> of the Nsmf_EventExposure API

17.5.0

2021-12

CT#94e

CP-213223

0149

1

B

Adding EAS IP replacement information in AppRelocationInfo

17.5.0

2021-12

CT#94e

CP-213228

0150

1

B

Adding DCCF as SMF event exposure NF service consumer

17.5.0

2021-12

CT#94e

CP-213239

0151

F

Adding missing conditions on features for notifications about subscribed events

17.5.0

2021-12

CT#94e

CP-213244

0152

F

Handling of implicit subscriptions

17.5.0

2021-12

CT#94e

CP-213215

0154

1

A

Essential correction to immediate report

17.5.0

2021-12

CT#94e

CP-213228

0155

1

B

Transactions dispersion information collected from serving SMF

17.5.0

2021-12

CT#94e

CP-213246

0156

F

Update of OpenAPI version and TS version in externalDocs field

17.5.0

2022-03

CT#95e

CP-220195

0159

4

B

Event report in the subscription response

17.6.0

2022-03

CT#95e

CP-220189

0161

1

B

Support Redundant Transmission Experience

17.6.0

2022-03

CT#95e

CP-220189

0162

1

B

Support new event on WLAN information

17.6.0

2022-03

CT#95e

CP-220190

0163

1

F

Corrections related to SMCCE

17.6.0

2022-03

CT#95e

CP-220190

0164

1

F

Corrections related to Dispersion

17.6.0

2022-03

CT#95e

CP-220192

0165

1

D

Correction of SMCC and other abbreviations

17.6.0

2022-03

CT#95e

CP-220186

0166

1

F

Handling of supported features for Edge Computing

17.6.0

2022-03

CT#95e

CP-220175

0168

A

Corrections related to URLLC

17.6.0

2022-03

CT#95e

CP-220201

0169

B

Updating Binding Indication for multiple resource contexts feature

17.6.0

2022-03

CT#95e

CP-220191

0170

B

Provide PDU session information for supporting the UE communication analytics

17.6.0

2022-03

CT#95e

CP-220192

0171

1

B

Support UPF information for service experience and DN performance analytics

17.6.0

2022-03

CT#95e

CP-220194

0172

F

Update of info and externalDocs fields

17.6.0

2022-06

CT#96

CP-221154

0173

1

F

Formatting of description fields

17.7.0

2022-06

CT#96

CP-221154

0174

F

Using the common data type for FQDN

17.7.0

2022-06

CT#96

CP-221157

0175

F

Inaccurate condition for immediate reporting

17.7.0

2022-06

CT#96

CP-221129

0176

F

Correction to the notifFlag attribute in subscription modification

17.7.0

2022-06

CT#96

CP-221129

0177

F

Completion of subscription modification procedure

17.7.0

2022-06

CT#96

CP-221129

0178

F

missing applicable RED_TRANS_EXP event for targetPeriod attribute

17.7.0

2022-06

CT#96

C3-221130

0179

1

B

Resolve editor’s note on Redundant Transmission Experience event

17.7.0

2022-06

CT#96

CP-221130

0180

F

Corrections to SMCCE

17.7.0

2022-06

CT#96

CP-221133

0181

F

Muting notifications correction

17.7.0

2022-06

CT#96

CP-221157

0182

1

F

Correction to the reported flows

17.7.0

2022-06

CT#96

CP-221151

0183

F

Update of info and externalDocs fields

17.7.0

2022-09

CT#97e

CP-222123

0184

1

F

Alignment with the SBI template

17.8.0

2022-12

CT#98e

CP-223173

0186

1

F

User Plane Status Information event handling

17.9.0

2022-12

CT#98e

CP-223177

0188

F

Adding support of SNPN

17.9.0

2022-12

CT#98e

CP-223188

0190

F

Update of info and externalDocs fields

17.9.0

2022-12

CT#98e

CP-223191

0187

F

Adding the mandatory error code 502 Bad Gateway

18.0.0

2022-12

CT#98e

CP-223192

0189

1

F

Enumeration definitions in the OpenAPI file

18.0.0

2022-12

CT#98e

CP-223189

0191

F

Update of info and externalDocs fields

18.0.0