5 API Definitions
29.5913GPP5G SystemNetwork Exposure Function Southbound ServicesRelease 17Stage 3TS
5.1 Nnef_EventExposure Service API
5.1.1 Introduction
The Nnef_EventExposure service shall use the Nnef_EventExposure API.
The API URI of the Nnef_EventExposure API shall be:
{apiRoot}/<apiName>/<apiVersion>
The request URIs used in HTTP requests from the NF service consumer towards the NF service producer shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.:
{apiRoot}/<apiName>/<apiVersion>/<apiSpecificResourceUriPart>
with the following components:
– The {apiRoot} shall be set as described in 3GPP TS 29.501 [5].
– The <apiName> shall be "nnef-eventexposure".
– The <apiVersion> shall be "v1".
– The <apiSpecificResourceUriPart> shall be set as described in clause 5.1.3.
5.1.2 Usage of HTTP
5.1.2.1 General
HTTP/2, IETF RFC 7540 [11], shall be used as specified in clause 5 of 3GPP TS 29.500 [4].
HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4].
The OpenAPI [6] specification of HTTP messages and content bodies for the Nnef_EventExposure API is contained in Annex A.
5.1.2.2 HTTP standard headers
5.1.2.2.1 General
See clause 5.2.2 of 3GPP TS 29.500 [4] for the usage of HTTP standard headers.
5.1.2.2.2 Content type
JSON, IETF RFC 8259 [12], shall be used as content type of the HTTP bodies specified in the present specification as specified in clause 5.4 of 3GPP TS 29.500 [4]. The use of the JSON format shall be signalled by the content type "application/json".
"Problem Details" JSON object shall be used to indicate additional details of the error in a HTTP response body and shall be signalled by the content type "application/problem+json", as defined in IETF RFC 7807 [13].
5.1.2.3 HTTP custom headers
The Nnef_EventExposure API shall support mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [4] and may support HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [4].
In this Release of the specification, no specific custom headers are defined for the Nnef_EventExposure API.
5.1.3 Resources
5.1.3.1 Overview
This clause describes the structure for the Resource URIs and the resources and methods used for the service.
Figure 5.1.3.1-1 depicts the resource URIs structure for the Nnef_EventExposure API.
Figure 5.1.3.1-1: Resource URI structure of the Nnef_EventExposure API
Table 5.1.3.1-1 provides an overview of the resources and applicable HTTP methods.
Table 5.1.3.1-1: Resources and methods overview
|
Resource name |
Resource URI |
HTTP method or custom operation |
Description |
|
Network Exposure Event Subscriptions |
/subscriptions |
POST |
Creates a subscription to notifications on application or user related event(s), i.e. creation of an Individual Network Exposure Event Subscription resource. |
|
Individual Network Exposure Event Subscription |
/subscriptions/{subscriptionId} |
GET |
Reads an Individual Network Exposure Event Subscription resource. |
|
PUT |
Modifies an Individual Network Exposure Event Subscription. |
||
|
DELETE |
Cancels an individual subscription to notifications of subscribed event. |
5.1.3.2 Resource: Network Exposure Event Subscriptions
5.1.3.2.1 Description
The resource represents the collection of Network Exposure Event subscriptions of the Nnef_EventExposure service. It allows NF service consumers to create a new subscription to notifications on application or user related event(s).
5.1.3.2.2 Resource Definition
Resource URI: {apiRoot}/nnef-eventexposure/<apiVersion>/subscriptions
This resource shall support the resource URI variables defined in table 5.1.3.2.2-1.
Table 5.1.3.2.2-1: Resource URI variables for this resource
|
Name |
Data type |
Definition |
|
apiRoot |
string |
See clause 5.1.1 |
5.1.3.2.3 Resource Standard Methods
5.1.3.2.3.1 POST
This method shall support the URI query parameters specified in table 5.1.3.2.3.1-1.
Table 5.1.3.2.3.1-1: URI query parameters supported by the <method 1> method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
n/a |
This method shall support the request data structures specified in table 5.1.3.2.3.1-2 and the response data structures and response codes specified in table 5.1.3.2.3.1-3.
Table 5.1.3.2.3.1-2: Data structures supported by the POST Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
NefEventExposureSubsc |
M |
1 |
Contains the information required for the creation of a new Individual Network Exposure Event Subscription resource. |
Table 5.1.3.2.3.1-3: Data structures supported by the POST Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
NefEventExposureSubsc |
M |
1 |
201 Created |
Contains the representation of the Individual Network Exposure Event Subscription resource. |
|
NOTE: The manadatory HTTP error status code for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. |
||||
Table 5.1.3.2.3.1-4: Headers supported by the 201 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
Contains the URI of the newly created resource, according to the structure: {apiRoot}/nnef-eventexposure/<apiVersion>/subscriptions/{subscriptionId} |
5.1.3.3 Resource: Individual Network Exposure Event Subscription
5.1.3.3.1 Description
The resource represents an individual Network Exposure Event subscription of the Nnef_EventExposure service. It allows NF service consumers to read/modify/cancel a subscription to notifications on application or user related event(s).
5.1.3.3.2 Resource Definition
Resource URI: {apiRoot}/nnef-eventexposure/<apiVersion>/subscriptions/{subscriptionId}
This resource shall support the resource URI variables defined in table 5.1.3.3.2-1.
Table 5.1.3.3.2-1: Resource URI variables for this resource
|
Name |
Data type |
Definition |
|
apiRoot |
string |
See clause 5.1.1 |
|
subscriptionId |
string |
Identifies a subscription to the NEF event exposure service. |
5.1.3.3.3 Resource Standard Methods
5.1.3.3.3.1 GET
This method shall support the URI query parameters specified in table 5.1.3.3.3.1-1.
Table 5.1.3.3.3.1-1: URI query parameters supported by the GET method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
supp-feat |
SupportedFeatures |
O |
0..1 |
The features supported by the NF service consumer. |
This method shall support the request data structures specified in table 5.1.3.3.3.1-2 and the response data structures and response codes specified in table 5.1.3.3.3.1-3.
Table 5.1.3.3.3.1-2: Data structures supported by the GET Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
n/a |
Table 5.1.3.3.3.1-3: Data structures supported by the GET Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
NefEventExposureSubsc |
M |
1 |
200 OK |
Contains the representation of the Individual Network Exposure 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 NEF (service) instance. Applicable if the feature "ES3XX" is supported. |
|
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 NEF (service) instance. Applicable if the feature "ES3XX" is supported. |
|
NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. |
||||
Table 5.1.3.3.3.1-4: Headers supported by the 307 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
An alternative URI of the resource located in an alternative NEF (service) instance. |
|
3gpp-Sbi-Target-Nf-Id |
string |
O |
0..1 |
Identifier of the target NF (service) instance towards which the request is redirected. |
Table 5.1.3.3.3.1-5: Headers supported by the 308 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
An alternative URI of the resource located in an alternative NEF (service) instance. |
|
3gpp-Sbi-Target-Nf-Id |
string |
O |
0..1 |
Identifier of the target NF (service) instance towards which the request is redirected. |
5.1.3.3.3.2 PUT
This method shall support the URI query parameters specified in table 5.1.3.3.3.2-1.
Table 5.1.3.3.3.2-1: URI query parameters supported by the PUT method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
n/a |
This method shall support the request data structures specified in table 5.1.3.3.3.2-2 and the response data structures and response codes specified in table 5.1.3.3.3.2-3.
Table 5.1.3.3.3.2-2: Data structures supported by the PUT Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
NefEventExposureSubsc |
M |
1 |
Modifies the existing Individual Network Exposure Event Subscription resource. |
Table 5.1.3.3.3.2-3: Data structures supported by the PUT Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
NefEventExposureSubsc |
M |
1 |
200 OK |
Successful case. The Individual Network Exposure Event Subscription resource was modified and a representation is returned. |
|
n/a |
204 No Content |
Successful case. The Individual Network Exposure 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 NEF (service) instance. Applicable if the feature "ES3XX" is supported. |
|
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 NEF (service) instance. Applicable if the feature "ES3XX" is supported. |
|
NOTE: The mandatory HTTP error status codes for the PUT method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. |
||||
Table 5.1.3.3.3.2-4: Headers supported by the 307 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
An alternative URI of the resource located in an alternative NEF (service) instance. |
|
3gpp-Sbi-Target-Nf-Id |
string |
O |
0..1 |
Identifier of the target NF (service) instance towards which the request is redirected. |
Table 5.1.3.3.3.2-5: Headers supported by the 308 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
An alternative URI of the resource located in an alternative NEF (service) instance. |
|
3gpp-Sbi-Target-Nf-Id |
string |
O |
0..1 |
Identifier of the target NF (service) instance towards which the request is redirected. |
5.1.3.3.3.3 DELETE
This method shall support the URI query parameters specified in table 5.1.3.3.3.3-1.
Table 5.1.3.3.3.3-1: URI query parameters supported by the DELETE method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
n/a |
This method shall support the request data structures specified in table 5.1.3.3.3.3-2 and the response data structures and response codes specified in table 5.1.3.3.3.3-3.
Table 5.1.3.3.3.3-2: Data structures supported by the DELETE Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
n/a |
Table 5.1.3.3.3.3-3: Data structures supported by the DELETE Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
n/a |
204 No Content |
Successful case. The Individual Network Exposure 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 NEF (service) instance. Applicable if the feature "ES3XX" is supported. |
|
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 NEF (service) instance. Applicable if the feature "ES3XX" is supported. |
|
NOTE: The mandatory HTTP error status code for the DELETE method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. |
||||
Table 5.1.3.3.3.3-4: Headers supported by the 307 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
An alternative URI of the resource located in an alternative NEF (service) instance. |
|
3gpp-Sbi-Target-Nf-Id |
string |
O |
0..1 |
Identifier of the target NF (service) instance towards which the request is redirected. |
Table 5.1.3.3.3.3-5: Headers supported by the 308 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
An alternative URI of the resource located in an alternative NEF (service) instance. |
|
3gpp-Sbi-Target-Nf-Id |
string |
O |
0..1 |
Identifier of the target NF (service) instance towards which the request is redirected. |
5.1.4 Custom Operations without associated resources
None.
5.1.5 Notifications
5.1.5.1 General
Notifications shall comply to clause 6.2 of 3GPP TS 29.500 [4] and clause 4.6.2.3 of 3GPP TS 29.501 [5].
Table 5.1.5.1-1: Notifications overview
|
Notification |
Callback URI |
HTTP method or custom operation |
Description (service operation) |
|
Network Exposure Event Notification |
{notifUri} |
POST |
Provides Information about observed events. |
5.1.5.2 Network Exposure Event Notification
5.1.5.2.1 Description
The Network Exposure Event Notification is used by the NEF to report one or several observed Events to a NF service consumer that has subscribed to such Notifications.
5.1.5.2.2 Target URI
The Notification URI "{notifUri}" shall be used with the callback URI variables defined in table 5.1.5.2.2-1.
Table 5.1.5.2.2-1: Callback URI variables for this resource
|
Name |
Data type |
Definition |
|
notifUri |
Uri |
The Notification Uri as assigned by the NF service consumer during the subscription service operation and described within the NefEventExposureSubsc data type (see table 5.1.6.2.2-1). |
5.1.5.2.3 Standard Methods
5.1.5.2.3.1 POST
This method shall support the request data structures specified in table 5.1.5.2.3.1-1 and the response data structures and response codes specified in table 5.1.5.2.3.1-1.
Table 5.1.5.2.3.1-2: Data structures supported by the POST Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
NefEventExposureNotif |
M |
1 |
Provides Information about observed events |
Table 5.1.5.2.3.1-3: Data structures supported by the POST Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
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. |
|
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: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. |
||||
Table 5.1.5.2.3.1-4: Headers supported by the 307 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
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. |
Table 5.1.5.2.3.1-5: Headers supported by the 308 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
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. |
5.1.6 Data Model
5.1.6.1 General
This clause specifies the application data model supported by the API.
Table 5.1.6.1-1 specifies the data types defined for the Nnef_EventExposure service based interface protocol.
Table 5.1.6.1-1: Nnef_EventExposure specific Data Types
|
Data type |
Section defined |
Description |
Applicability |
||
|
NefEvent |
5.1.6.3.3 |
Represents Network Exposure Events. |
|||
|
NefEventExposureNotif |
5.1.6.2.3 |
Represents notifications on network exposure event(s) that occurred for an Individual Network Exposure Event Subscription resource. |
|||
|
NefEventExposureSubsc |
5.1.6.2.2 |
Represents an Individual Network Exposure Event Subscription resource. |
|||
|
NefEventFilter |
5.1.6.2.7 |
Represents event filter information for an event. |
|||
|
NefEventNotification |
5.1.6.2.4 |
Represents information related to an event to be reported. |
|||
|
NefEventSubs |
5.1.6.2.5 |
Represents an event to be subscribed and the related event filter information |
|||
|
PerformanceDataInfo |
5.1.6.2.12 |
Contains Performance Data Analytics related information collection |
PerformanceData |
||
|
ServiceExperienceInfo |
5.1.6.2.9 |
Contains service experience information associated with an application. |
ServiceExperience |
||
|
TargetUeIdentification |
5.1.6.2.8 |
Identifies the UE to which the request applies. |
|||
|
UeCommunicationInfo |
5.1.6.2.6 |
Contains UE communication information associated with an application. |
UeCommunication |
||
|
UeMobilityInfo |
5.1.6.2.10 |
Contains UE mobility information associated with an application. |
UeMobility |
||
|
UeTrajectoryInfo |
5.1.6.2.11 |
Contains UE trajectory information. |
UeMobility |
||
Table 5.1.6.1-2 specifies data types re-used by the Nnef_EventExposure service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nnef_EventExposure service based interface.
Table 5.1.6.1-2: Nnef_EventExposure re-used Data Types
|
Data type |
Reference |
Comments |
Applicability |
|||
|
AddrFqdn |
3GPP TS 29.517 [18] |
IP address and/or FQDN. |
||||
|
ApplicationId |
3GPP TS 29.571 [16] |
Application identifier |
||||
|
CollectiveBehaviourFilter |
3GPP TS 29.517 [18] |
Contains the parameter type and value pair to express the collective behaviour event filters. |
CollectiveBehaviour |
|||
|
CollectiveBehaviourInfo |
3GPP TS 29.517 [18] |
Contains the collective behaviour analytics information. |
CollectiveBehaviour |
|||
|
CommunicationCollection |
3GPP TS 29.517 [18] |
Contains communication information. |
UeCommunication |
|||
|
DateTime |
3GPP TS 29.571 [16] |
Contains a date and a time. |
||||
|
Dnai |
3GPP TS 29.571 [16] |
|||||
|
DispersionCollection |
3GPP TS 29.517 [18] |
Contains dispersion collection information. |
Dispersion |
|||
|
ExceptionInfo |
3GPP TS 29.517 [18] |
Represents exception information for a service flow. |
Exceptions |
|||
|
GroupId |
3GPP TS 29.571 [16] |
Contains a Group identifier. |
||||
|
IpAddr |
3GPP TS 29.571 [16] |
Identifies the IP address of a UE. |
PerformanceData |
|||
|
MSAccessActivityCollection |
3GPP TS 29.517 [18] |
Represents the Media Streaming access activity of UE Application collected via Data Collection AF. |
MSAccessActivity |
|||
|
MsConsumptionCollection |
3GPP TS 29.517 [18] |
Represents the Media Streaming Consumption reports of UE Application collected via Data Collection AF. |
MSConsumption |
|||
|
MsDynPolicyInvocationCollection |
3GPP TS 29.517 [18] |
Represents the Media Streaming Dynamic Policy Invocation of UE Application collected via Data Collection AF. |
MSDynPolicyInvocation |
|||
|
MsQoeMetricsCollection |
3GPP TS 29.517 [18] |
Represents the Media Streaming QoE Metrics of UE Application collected via Data Collection AF. |
MSQoeMetrics |
|||
|
MsNetAssInvocationCollection |
3GPP TS 29.517 [18] |
Represents the Media Streaming Network Assistance invocation of UE Application collected via Data Collection AF. |
MSNetAssInvocation |
|||
|
NetworkAreaInfo |
3GPP TS 29.554 [21] |
Represents a network area information. |
||||
|
PacketDelBudget |
3GPP TS 29.571 [16] |
Indicates average Packet Delay. |
PerformanceData |
|||
|
PacketLossRate |
3GPP TS 29.571 [16] |
Indicates average Loss Rate. |
PerformanceData |
|||
|
PerformanceData |
3GPP TS 29.517 [18] |
Contains Performance Data |
PerformanceData |
|||
|
RedirectResponse |
3GPP TS 29.571 [16] |
Contains redirection related information. |
ES3XX |
|||
|
ReportingInformation |
3GPP TS 29.523 [22] |
Represents the type of reporting the subscription requires. |
||||
|
Supi |
3GPP TS 29.571 [16] |
Contains a SUPI. |
||||
|
SupportedFeatures |
3GPP TS 29.571 [16] |
Indicates the features supported. |
||||
|
ServiceExperienceInfoPerFlow |
3GPP TS 29.517 [18] |
Contains service experience information associated with a service flow. |
ServiceExperience |
|||
|
UserDataCongestionCollection |
3GPP TS 29.517 [18] |
Contains User Data Congestion Analytics related information collection. |
UserDataCongestion |
|||
|
UserLocation |
3GPP TS 29.571 [16] |
Contains user location information. |
UeMobility |
|||
|
Uri |
3GPP TS 29.571 [16] |
Contains a URI. |
||||
5.1.6.2 Structured data types
5.1.6.2.1 Introduction
This clause defines the structures to be used in resource representations.
5.1.6.2.2 Type: NefEventExposureSubsc
Table 5.1.6.2.2-1: Definition of type NefEventExposureSubsc
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
dataAccProfId |
string |
O |
0..1 |
Represents a unique identifier for the Data Access Profile. |
DataAccProfileId |
|
eventsSubs |
array(NefEventSubs) |
M |
1..N |
Subscribed events and the related event filters. |
|
|
eventsRepInfo |
ReportingInformation |
O |
0..1 |
Represents the reporting requirements of the subscription. If omitted, the default values within the ReportingInformation data type apply. |
|
|
notifUri |
Uri |
M |
1 |
Notification URI for event reporting. |
|
|
eventNotifs |
array(NefEventNotificationData) |
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. |
|
|
notifId |
string |
M |
1 |
Notification Correlation ID assigned by the NF service consumer. |
|
|
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 NEF. |
|||||
5.1.6.2.3 Type: NefEventExposureNotif
Table 5.1.6.2.3-1: Definition of type NefEventExposureNotif
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
notifId |
string |
M |
1 |
Notification Correlation ID assigned by the NF service consumer. |
|
|
eventNotifs |
array(NefEventNotification) |
M |
1..N |
Represents the Events to be reported according to the subscription corresponding to the Notification Correlation ID. |
5.1.6.2.4 Type: NefEventNotification
Table 5.1.6.2.4-1: Definition of type NefEventNotification
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
event |
NefEvent |
M |
1 |
Represents the reported application related event. |
|
|
timeStamp |
DateTime |
M |
1 |
Time at which the event is observed. |
|
|
svcExprcInfos |
array(ServiceExperienceInfo) |
C |
1..N |
Contains the service experience information. Shall be present if the "event" attribute sets to "SVC_EXPERIENCE" |
ServiceExperience |
|
ueMobilityInfos |
array(UeMobilityInfo) |
C |
1..N |
Contains the UE mobility information. Shall be present if the "event" attribute sets to "UE_MOBILITY" |
UeMobility |
|
ueCommInfos |
array(UeCommunicationInfo) |
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 for an AF application. Shall be present if the "event" attribute sets to "USER_DATA_CONGESTION". |
UserDataCongestion |
|
perfDataInfos |
array(PerformanceDataInfo) |
C |
1..N |
Each element represents the performance data information collected for an AF application. |
PerformanceData |
|
dispersionInfos |
array(DispersionCollection) |
C |
1..N |
Each element represents the UE dispersion information collected for an AF. Shall be present if the "event" attribute sets to "DISPERSION". |
Dispersion |
|
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 |
|
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 reports 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 "MS_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 |
5.1.6.2.5 Type NefEventSubs
Table 5.1.6.2.5-1: Definition of type NefEventSubs
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
event |
NefEvent |
M |
1 |
Subscribed event. |
|
|
eventFilter |
NefEventFilter |
C |
0..1 |
Represents the event filter information associated with each event. Shall be present if "event" sets to "SVC_EXPERIENCE", "UE_MOBILITY", "UE_COMM", "EXCEPTIONS", "USER_DATA_CONGESTION", "PERF_DATA" "COLLECTIVE_BEHAVIOUR", "DISPERSION", "MS_QOE_METRICS", "MS_CONSUMPTION", "MS_NET_ASSIST_INVOCATION", "MS_DYN_POLICY_INVOCATION" or "MS_ACCESS_ACTIVITY". |
ServiceExperience UeCommunication UeMobility Exceptions UserDataCongestion PerformanceData Dispersion CollectiveBehaviour MSQoeMetrics MSConsumption MSNetAssInvocation MSDynPolicyInvocation MSAccessActivity |
5.1.6.2.6 Type UeCommunicationInfo
Table 5.1.6.2.6-1: Definition of type UeCommunicationInfo
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
supi |
Supi |
C |
0..1 |
Identifies an UE. Shall be present if the event exposure request applies to more than one UE. |
|
|
interGroupId |
GroupId |
O |
0..1 |
Identifies an UE group. |
|
|
appId |
ApplicationId |
O |
0..1 |
Identifies an application identifier. |
|
|
comms |
array(CommunicationCollection) |
M |
1..N |
This attribute contains a list of communication information. |
5.1.6.2.7 Type NefEventFilter
Table 5.1.6.2.7-1: Definition of type NefEventFilter
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
tgtUe |
TargetUeIdentification |
M |
1 |
Represents the UE information to which the request applies. |
(NOTE 1) |
|
appIds |
array(ApplicationId) |
C |
1..N |
Each element indicates an application identifier. If absent, the NefEventFilter data applies to any application (i.e. all applications). (NOTE 2) |
ServiceExperience Exceptions UeCommunication UeMobilityUserDataCongestion PerformanceData Dispersion MSQoeMetrics MSConsumption MSNetAssInvocation MSDynPolicyInvocation MSAccessActivity |
|
locArea |
NetworkAreaInfo |
O |
0..1 |
Represents an area of interest. (NOTE 3) |
ServiceExperience Exceptions UeCommunication UeMobility UserDataCongestion 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: Applicability is further described in the corresponding data type. NOTE 2: For the events "EXCEPTIONS", "UE_MOBILITY", "UE_COMM", and "PERF_DATA", if present, the "appIds" attribute shall include only one element. NOTE 3: For event "SVC_EXPERIENCE", only the " tais " attribute within the NetworkAreaInfo data is applicable. |
|||||
5.1.6.2.8 Type TargetUeIdentification
Table 5.1.6.2.8-1: Definition of type TargetUeIdentification
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
supis |
array(Supi) |
O |
1..N |
Each element identifies a SUPI for an UE. |
ServiceExperience Exceptions UeMobility UeCommunication UserDataCongestion Dispersion MSQoeMetrics MSConsumption MSNetAssInvocation MSDynPolicyInvocation MSAccessActivity |
|
interGroupIds |
array(GroupId) |
O |
1..N |
Each element represents an internal group identifier which identifies a group of UEs. |
ServiceExperience Exceptions UeMobility UeCommunication MSQoeMetrics MSConsumption MSNetAssInvocation MSDynPolicyInvocation MSAccessActivity |
|
anyUeId |
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". |
ServiceExperience Exceptions UserDataCongestion |
|
NOTE: For an applicable feature, only one attribute identifying the target UE shall be provided. |
|||||
5.1.6.2.9 Type: ServiceExperienceInfo
Table 5.1.6.2.9-1: Definition of type ServiceExperienceInfo
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
appId |
ApplicationId |
C |
0..1 |
Identifies an application identifier. Shall be present if the event exposure service request applies to more than one application. |
ServiceExperience |
|
supis |
array(Supi) |
C |
1..N |
Each element represents the internal UE identifier. |
ServiceExperience |
|
svcExpPerFlows |
array(ServiceExperienceInfoPerFlow) |
M |
1..N |
Each element indicates service experience for each service flow. |
ServiceExperience |
5.1.6.2.10 Type: UeMobilityInfo
Table 5.1.6.2.10-1: Definition of type UeMobilityInfo
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
supi |
Supi |
M |
1 |
Identifies an UE. Shall be present if the event exposure request applies to more than one UE. |
|
|
appId |
ApplicationId |
O |
0..1 |
Identifies an application identifier. |
|
|
ueTrajs |
array(UeTrajectoryInfo) |
M |
1..N |
Identifies an UE moving trajectory. |
5.1.6.2.11 Type: UeTrajectoryInfo
Table 5.1.6.2.11-1: Definition of type UeTrajectoryInfo
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
ts |
DateTime |
M |
1 |
Identifies the timestamp when the UE enters this area. |
|
|
location |
UserLocation |
M |
1 |
Includes the location of the UE. (NOTE) |
|
|
NOTE: Only EutraLocation data and/or NrLocation data in UserLocation data are applicable to the property. |
|||||
5.1.6.2.12 Type PerformanceDataInfo
Table 5.1.6.2.12-1: Definition of type PerformanceDataInfo
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
appId |
ApplicationId |
O |
0..1 |
Indicates an application identifier. |
|
|
ueIpAddr |
IpAddr |
O |
0..1 |
Identifies the IP address of a UE. |
|
|
ipTrafficFilter |
FlowInfo |
O |
0..1 |
Identifies IP packet filter. |
|
|
userLoc |
UserLocation |
O |
0..1 |
Represents the user 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. |
|||||
5.1.6.3 Simple data types and enumerations
5.1.6.3.1 Introduction
This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses.
5.1.6.3.2 Simple data types
The simple data types defined in table 5.1.6.3.2-1 shall be supported.
Table 5.1.6.3.2-1: Simple data types
|
Type Name |
Type Definition |
Description |
Applicability |
5.1.6.3.3 Enumeration: NefEvent
The enumeration NefEvent represents the observed event requested by the NF service consumer to be monitored. It shall comply with the provisions defined in table 5.1.6.3.3-1.
Table 5.1.6.3.3-1: Enumeration NefEvent
|
Enumeration value |
Description |
Applicability |
|
SVC_EXPERIENCE |
Indicates that the observed event is service experience information. |
ServiceExperience |
|
UE_COMM |
Indicates that the observed event is UE communication information. |
UeCommunication |
|
UE_MOBILITY |
Indicates that the observed event is UE mobility information. |
UeMobility |
|
EXCEPTIONS |
Indicates that the observed event 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 |
|
DISPERSION |
Indicates that the event subscribed is dispersion information. |
Dispersion |
|
COLLECTIVE_BEHAVIOUR |
Indicates that the event subscribed is collective behaviour information. |
CollectiveBehaviour |
|
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 |
5.1.7 Error Handling
5.1.7.1 General
For the Nnef_EventExposure API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [5]. Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [4] shall be supported for an HTTP method if the corresponding HTTP status codes are specified as mandatory for that HTTP method in table 5.2.7.1-1 of 3GPP TS 29.500 [4].
In addition, the requirements in the following clauses are applicable for the Nnef_EventExposure API.
5.1.7.2 Protocol Errors
No specific procedures for the Nnef_EventExposure service are specified.
5.1.7.3 Application Errors
The application errors defined for the Nnef_EventExposure service are listed in Table 5.1.7.3-1.
Table 5.1.7.3-1: Application errors
|
Application Error |
HTTP status code |
Description |
5.1.8 Feature negotiation
The optional features in table 5.1.8-1 are defined for the Nnef_EventExposure API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4].
Table 5.1.8-1: Supported Features
|
Feature number |
Feature Name |
Description |
|
1 |
ServiceExperience |
This feature indicates support for the "SVC_EXPERIENCE" event. |
|
2 |
UeMobility |
This feature indicates support for the "UE_MOBILITY" event. |
|
3 |
UeCommunication |
This feature indicates support for the "UE_COMM" event. |
|
4 |
Exceptions |
This feature indicates support for the "EXCEPTIONS" event. |
|
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 [4] and according to HTTP redirection principles for indirect communication, as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. |
|
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 of collective behaviour information associated with the UEs and its applications. |
|
11 |
MSQoeMetrics |
This feature indicates support for the event related to Media Streaming QoE metrics for UE Application collected via the Data Collection AF. |
|
12 |
MSConsumption |
This feature indicates support for the event related to Media Streaming Consumption reports for UE Application collected via the Data Collection AF. |
|
13 |
MSNetAssInvocation |
This feature indicates support for the event related to Media Streaming Network Assistance invocation for UE Application collected via the Data Collection AF. |
|
14 |
MSDynPolicyInvocation |
This feature indicates support for the event related to Media Streaming Dynamic Policy invocation for UE Application collected via the Data Collection AF. |
|
15 |
MSAccessActivity |
This feature indicates support for the event related to Media Streaming access activity for UE Application collected via the Data Collection AF. |
|
16 |
DataAccProfileId |
This feature indicates support for Data Access Profile Identifier. |
5.1.9 Security
As indicated in 3GPP TS 33.501 [8] and 3GPP TS 29.500 [4], the access to the Nnef_EventExposure API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [9]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [10]) plays the role of the authorization server.
If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Nnef_EventExposure API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [10], clause 5.4.2.2.
NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Nnef_EventExposure service.
The Nnef_EventExposure API defines a single scope "nnef-eventexposure" for the entire service, and it does not define any additional scopes at resource or operation level.
5.2 Nnef_EASDeployment Service API
5.2.1 Introduction
The Nnef_EASDeployment service shall use the Nnef_EASDeployment API.
The API URI of the Nnef_EASDeployment API shall be:
{apiRoot}/<apiName>/<apiVersion>
The request URIs used in HTTP requests from the NF service consumer towards the NF service producer shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.:
{apiRoot}/<apiName>/<apiVersion>/<apiSpecificResourceUriPart>
with the following components:
– The {apiRoot} shall be set as described in 3GPP TS 29.501 [5].
– The <apiName> shall be "nnef-eas-deployment".
– The <apiVersion> shall be "v1".
– The <apiSpecificResourceUriPart> shall be set as described in clause 5.2.3.
5.2.2 Usage of HTTP
5.2.2.1 General
HTTP/2, IETF RFC 7540 [11], shall be used as specified in clause 5 of 3GPP TS 29.500 [4].
HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4].
The OpenAPI [6] specification of HTTP messages and content bodies for the Nnef_EASDeployment API is contained in Annex 3.
5.2.2.2 HTTP standard headers
5.2.2.2.1 General
See clause 5.2.2 of 3GPP TS 29.500 [4] for the usage of HTTP standard headers.
5.2.2.2.2 Content type
JSON, IETF RFC 8259 [12], shall be used as content type of the HTTP bodies specified in the present specification as specified in clause 5.4 of 3GPP TS 29.500 [4]. The use of the JSON format shall be signalled by the content type "application/json".
"Problem Details" JSON object shall be used to indicate additional details of the error in a HTTP response body and shall be signalled by the content type "application/problem+json", as defined in IETF RFC 7807 [13].
5.2.2.3 HTTP custom headers
The Nnef_EASDeployment API shall support mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [4] and may support HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [4].
In this Release of the specification, no specific custom headers are defined for the Nnef_EASDeployment API.
5.2.3 Resources
5.2.3.1 Overview
This clause describes the structure for the Resource URIs and the resources and methods used for the service.
Figure 5.2.3.1-1 depicts the resource URIs structure for the Nnef_EASDeployment API.
Figure 5.2.3.1-1: Resource URI structure of the Nnef_EASDeployment API
Table 5.2.3.1-1 provides an overview of the resources and applicable HTTP methods.
Table 5.2.3.1-1: Resources and methods overview
|
Resource name |
Resource URI |
HTTP method or custom operation |
Description |
|
EAS Deployment Event Subscriptions |
/subscriptions |
POST |
Creates a subscription to notifications of changes of EAS Deployment Information, i.e. creation of an Individual EAS Deployment Event Subscription resource. |
|
Individual EAS Deployment Event Subscription |
/subscriptions/{subscriptionId} |
GET |
Reads an Individual EAS Deployment Event Subscription resource. |
|
DELETE |
Cancels an individual subscription to notifications of subscribed EAS Deployment changes event. |
5.2.3.2 Resource: EAS Deployment Event Subscriptions
5.2.3.2.1 Description
The resource represents the collection of EAS Deployment changes Event subscriptions of the Nnef_EASDeployment service. It allows NF service consumers to create a new subscription to notifications on EAS Deployment changes event(s).
5.2.3.2.2 Resource Definition
Resource URI: {apiRoot}/nnef-eas-deployment/<apiVersion>/subscriptions
This resource shall support the resource URI variables defined in table 5.2.3.2.2-1.
Table 5.2.3.2.2-1: Resource URI variables for this resource
|
Name |
Data type |
Definition |
|
apiRoot |
string |
See clause 5.2.1 |
5.2.3.2.3 Resource Standard Methods
5.2.3.2.3.1 POST
This method shall support the URI query parameters specified in table 5.2.3.2.3.1-1.
Table 5.2.3.2.3.1-1: URI query parameters supported by the POST method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
n/a |
This method shall support the request data structures specified in table 5.2.3.2.3.1-2 and the response data structures and response codes specified in table 5.2.3.2.3.1-3.
Table 5.2.3.2.3.1-2: Data structures supported by the POST Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
EasDeploySubData |
M |
1 |
Contains the information required for the creation of a new Individual EAS Deployment Event Subscription resource. |
Table 5.2.3.2.3.1-3: Data structures supported by the POST Response Body on this resource
|
Data type |
P |
Cardinality |
Response Codes |
Description |
|
EasDeploySubData |
M |
1 |
201 Created |
Contains the representation of the Individual EAS Deployment Event Subscription resource. |
|
NOTE: The manadatory HTTP error status code for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. |
||||
Table 5.2.3.2.3.1-4: Headers supported by the 201 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
Contains the URI of the newly created resource, according to the structure: {apiRoot}/nnef-eas-deployment/<apiVersion>/subscriptions/{subscriptionId} |
5.2.3.3 Resource: Individual EAS Deployment Event Subscription
5.2.3.3.1 Description
The resource represents an individual EAS Deployment Event subscription of the Nnef_EASDeployment service. It allows NF service consumers to subscribe/unsubscribe an EAS Deployment information change event, and allows the NEF to notify EAS Deployment change event to the subscribed NF service consumer.
5.2.3.3.2 Resource Definition
Resource URI: {apiRoot}/nnef-eas-deployment/<apiVersion>/subscriptions/{subscriptionId}
This resource shall support the resource URI variables defined in table 5.2.3.3.2-1.
Table 5.2.3.3.2-1: Resource URI variables for this resource
|
Name |
Data type |
Definition |
|
apiRoot |
string |
See clause 5.2.1 |
|
subscriptionId |
string |
Identifies a subscription to the NEF event exposure service. |
5.2.3.3.3 Resource Standard Methods
5.2.3.3.3.1 GET
This method shall support the URI query parameters specified in table 5.2.3.3.3.1-1.
Table 5.2.3.3.3.1-1: URI query parameters supported by the GET method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
This method shall support the request data structures specified in table 5.2.3.3.3.1-2 and the response data structures and response codes specified in table 5.2.3.3.3.1-3.
Table 5.2.3.3.3.1-2: Data structures supported by the GET Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
n/a |
Table 5.2.3.3.3.1-3: Data structures supported by the GET Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
EasDeploySubData |
M |
1 |
200 OK |
Contains the representation of the Individual EAS Deployment information changes 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 NEF (service) instance. |
|
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 NEF (service) instance. |
|
NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. |
||||
Table 5.2.3.3.3.1-4: Headers supported by the 307 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
An alternative URI of the resource located in an alternative NEF (service) instance. |
|
3gpp-Sbi-Target-Nf-Id |
string |
O |
0..1 |
Identifier of the target NF (service) instance towards which the request is redirected. |
Table 5.2.3.3.3.1-5: Headers supported by the 308 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
An alternative URI of the resource located in an alternative NEF (service) instance. |
|
3gpp-Sbi-Target-Nf-Id |
string |
O |
0..1 |
Identifier of the target NF (service) instance towards which the request is redirected. |
5.2.3.3.3.2 PUT
This HTTP method is not supported for the resource.
5.2.3.3.3.3 DELETE
This method shall support the URI query parameters specified in table 5.2.3.3.3.3-1.
Table 5.2.3.3.3.3-1: URI query parameters supported by the DELETE method on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
n/a |
This method shall support the request data structures specified in table 5.2.3.3.3.3-2 and the response data structures and response codes specified in table 5.2.3.3.3.3-3.
Table 5.2.3.3.3.3-2: Data structures supported by the DELETE Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
n/a |
Table 5.2.3.3.3.3-3: Data structures supported by the DELETE Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
n/a |
204 No Content |
Successful case. The Individual EAS Deployment information changes 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 NEF (service) instance. |
|
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 NEF (service) instance. |
|
NOTE: The mandatory HTTP error status code for the DELETE method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. |
||||
Table 5.2.3.3.3.3-4: Headers supported by the 307 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
An alternative URI of the resource located in an alternative NEF (service) instance. |
|
3gpp-Sbi-Target-Nf-Id |
string |
O |
0..1 |
Identifier of the target NF (service) instance towards which the request is redirected. |
Table 5.2.3.3.3.3-5: Headers supported by the 308 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
Location |
string |
M |
1 |
An alternative URI of the resource located in an alternative NEF (service) instance. |
|
3gpp-Sbi-Target-Nf-Id |
string |
O |
0..1 |
Identifier of the target NF (service) instance towards which the request is redirected. |
5.2.4 Custom Operations without associated resources
None.
5.2.5 Notifications
5.2.5.1 General
Notifications shall comply to clause 6.2 of 3GPP TS 29.500 [4] and clause 4.6.2.3 of 3GPP TS 29.501 [5].
Table 5.2.5.1-1: Notifications overview
|
Notification |
Callback URI |
HTTP method or custom operation |
Description (service operation) |
|
Event Notification |
{notifUri} |
POST |
Provides Information about EAS Deployment Information changes event(s). |
5.2.5.2 EAS Deployment Event Notification
5.2.5.2.1 Description
The EAS Deployment Event Notification is used by the NEF to report the observed EAS Deployment information changes event to a NF service consumer that has subscribed to such Notifications.
5.2.5.2.2 Target URI
The Notification URI "{notifUri}" shall be used with the callback URI variables defined in table 5.2.5.2.2-1.
Table 5.2.5.2.2-1: Callback URI variables for this resource
|
Name |
Data type |
Definition |
|
notifUri |
Uri |
The Notification Uri as assigned by the NF service consumer during the subscription service operation and described within the EasDeploySubData data type (see table 5.2.6.2.2-1). |
5.2.5.2.3 Standard Methods
5.2.5.2.3.1 POST
This method shall support the request data structures specified in table 5.2.5.2.3.1-1 and the response data structures and response codes specified in table 5.2.5.2.3.1-1.
Table 5.2.5.2.3.1-2: Data structures supported by the POST Request Body on this resource
|
Data type |
P |
Cardinality |
Description |
|
EasDeployInfoNotif |
M |
1 |
Provides Information about the EAS Deployment Information changes event. |
Table 5.2.5.2.3.1-3: Data structures supported by the POST Response Body on this resource
|
Data type |
P |
Cardinality |
Response codes |
Description |
|
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. |
|
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. |
|
NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. |
||||
Table 5.2.5.2.3.1-4: Headers supported by the 307 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
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. |
Table 5.2.5.2.3.1-5: Headers supported by the 308 Response Code on this resource
|
Name |
Data type |
P |
Cardinality |
Description |
|
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. |
5.2.6 Data Model
5.2.6.1 General
This clause specifies the application data model supported by the API.
Table 5.2.6.1-1 specifies the data types defined for the Nnef_EASDeployment service based interface protocol.
Table 5.2.6.1-1: Nnef_EASDeployment specific Data Types
|
Data type |
Section defined |
Description |
Applicability |
|
EasDeployInfoNotif |
5.2.6.2.3 |
Represents notifications on EAS Deployment Information changes event(s) that occurred for an Individual EAS Deployment Event Subscription resource. |
|
|
EasDeploySubData |
5.2.6.2.2 |
Represents EAS Deployment Information changes event(s) subscription data. |
|
|
EasDeployInfoData |
5.2.6.2.5 |
Represents the EAS Deployment Information to be reported. |
|
|
EasDepNotification |
5.2.6.2.4 |
Represents the EAS Deployment Notifcation. |
|
|
EasEvent |
5.2.6.3.3 |
represents the EAS event. |
Table 5.2.6.1-2 specifies data types re-used by the Nnef_EASDeployment service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nnef_EASDeployment service based interface.
Table 5.2.6.1-2: Nnef_EASDeployment re-used Data Types
|
Data type |
Reference |
Comments |
Applicability |
|
DnaiInformation |
3GPP TS 29.522 [15] |
Represents the DNAI inormation including the DNS server identifier (consisting of IP address and port) and/or IP address(s) of the EAS in the local DN for the DNAI. |
|
|
DnnSnssaiInformation |
3GPP TS 29.522 [15] |
Identifies a combination of (DNN, S-NSSAI). |
|
|
FqdnPatternMatchingRule |
3GPP TS 29.571 [16] |
Represents the FQDN pattern matching rule. |
|
|
GroupId |
3GPP TS 29.571 [16] |
Contains a Group identifier. |
|
|
Uri |
3GPP TS 29.571 [16] |
Contains a URI. |
5.2.6.2 Structured data types
5.2.6.2.1 Introduction
This clause defines the structures to be used in resource representations.
5.2.6.2.2 Type: EasDeploySubData
Table 5.2.6.2.2-1: Definition of type EasDeploySubData
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
appId |
string |
O |
0..1 |
Identifies the application for which the EAS Deployment Information corresponds to. |
|
|
dnnSnssaiInfos |
array(DnnSnssaiInformation) |
O |
1..N |
Each of the element identifies a combination of (DNN, S-NSSAI). |
|
|
eventId |
EasEvent |
M |
1 |
Event ID assigned by the NF service consumer. |
|
|
eventsNotifs |
array(EasDeployInfo) |
C |
1..N |
Represents the EAS Deployment Information changes event(s) to be reported. Shall only be present if the "immRep" attribute is included and sets to true, and the current status of EAS Deployment Information is available. |
|
|
immRep |
boolean |
O |
0..1 |
Indication of immediate reporting: – true: requires the immediate reporting of the current status of EAS Deployment Information, if available. – false (default): EAS Deployment Information event report occurs when the event is met. |
|
|
interGroupId |
GroupId |
O |
0..1 |
Identifies an internal UE group. |
|
|
notifId |
string |
M |
1 |
Notification Correlation ID assigned by the NF service consumer. |
|
|
notifUri |
Uri |
M |
1 |
Notification URI for the EAS Deployment Information event reporting. |
5.2.6.2.3 Type: EasDeployInfoNotif
Table 5.2.6.2.3-1: Definition of type EasDeployInfoNotif
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
easDepNotifs |
array(EasDepNotification) |
M |
1..N |
Represents the EAS Deployment Notifcation(s). |
|
|
notifId |
string |
M |
1 |
Notification Correlation ID assigned by the NF service consumer. |
5.2.6.2.4 Type: EasDepNotification
Table 5.2.6.2.4-1: Definition of type EasDepNotification
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
easDepInfo |
EasDeployInfoData |
M |
1 |
Represents the EAS Deployment Information to be reported. |
|
|
eventId |
EasEvent |
M |
1 |
Event ID assigned by the NF service consumer. |
5.2.6.2.5 Type: EasDeployInfoData
Table 5.2.6.2.5-1: Definition of type EasDeployInfoData
|
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
|
appId |
string |
O |
0..1 |
Identifies the application for which the EAS Deployment Information corresponds to. |
|
|
dnaiInfos |
map(DnaiInformation) |
O |
1..N |
list of DNS server identifier (consisting of IP address and port) and/or IP address(s) of the EAS in the local DN for each DNAI. The key of map is the DNAI. |
|
|
dnn |
Dnn |
O |
0..1 |
DNN for the EAS Deployment Information. |
|
|
fqdnPatternList |
array(FqdnPatternMatchingRule) |
M |
1..N |
Supported FQDN pattern(s) for application(s) deployed in the Local part of the DN where each FQDN pattern is described by a FQDN Pattern Matching Rule. |
|
|
interGroupId |
GroupId |
O |
0..1 |
Internal Group ID for the EAS Deployment Information. |
|
|
snssai |
Snssai |
O |
0..1 |
S-NSSAI for the EAS Deployment Information. |
5.2.6.3 Simple data types and enumerations
5.2.6.3.1 Introduction
This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses.
5.2.6.3.2 Simple data types
The simple data types defined in table 5.2.6.3.2-1 shall be supported.
Table 5.2.6.3.2-1: Simple data types
|
Type Name |
Type Definition |
Description |
Applicability |
5.2.6.3.3 Enumeration: EasEvent
The enumeration EasEvent represents the EAS event requested by the NF service consumer. It shall comply with the provisions defined in table 5.2.6.3.3-1.
Table 5.1.6.3.3-1: Enumeration EasEvent
|
Enumeration value |
Description |
Applicability |
|
EAS_INFO_CHG |
Indicates that the EAS Deployment Information is changed. |
5.2.7 Error Handling
5.2.7.1 General
For the Nnef_EASDeployment API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [5]. Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [4] shall be supported for an HTTP method if the corresponding HTTP status codes are specified as mandatory for that HTTP method in table 5.2.7.1-1 of 3GPP TS 29.500 [4].
In addition, the requirements in the following clauses are applicable for the Nnef_EASDeployment API.
5.2.7.2 Protocol Errors
No specific procedures for the Nnef_EASDeployment service are specified.
5.2.7.3 Application Errors
The application errors defined for the Nnef_EASDeployment service are listed in Table 5.2.7.3-1.
Table 5.2.7.3-1: Application errors
|
Application Error |
HTTP status code |
Description |
5.2.8 Feature negotiation
The optional features in table 5.2.8-1 are defined for the Nnef_EASDeployment API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4].
Table 5.2.8-1: Supported Features
|
Feature number |
Feature Name |
Description |
5.2.9 Security
As indicated in 3GPP TS 33.501 [8] and 3GPP TS 29.500 [4], the access to the Nnef_EASDeployment API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [9]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [10]) plays the role of the authorization server.
If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Nnef_EASDeployment API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [10], clause 5.4.2.2.
NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Nnef_EventExposure service.
The Nnef_EASDeployment API defines a single scope "nnef-eas-deployment" for the entire service, and it does not define any additional scopes at resource or operation level.
Annex A (normative):
OpenAPI specification