ETSI TS 129 522 V15.5.0 (2020-01)

5G; 5G System; Network Exposure Function Northbound APIs; Stage 3 (3GPP TS 29.522 version 15.5.0 Release 15)

RTS/TSGC-0329522vf50

General Information

• Status: Published
• Publication Date: 15-Jan-2020
• Technical Committee: 3GPP CT 3 - Interworking with external networks (formely CN3)
• Current Stage: 12 - Completion
• Completion Date: 16-Jan-2020

Standards Content (Sample)

TECHNICAL SPECIFICATION
5G;
5G System;
Network Exposure Function Northbound APIs;
Stage 3
(3GPP TS 29.522 version 15.5.0 Release 15)


3GPP TS 29.522 version 15.5.0 Release 15 1 ETSI TS 129 522 V15.5.0 (2020-01)

Reference
RTS/TSGC-0329522vf50
Keywords
5G
ETSI
650 Route des Lucioles
F-06921 Sophia Antipolis Cedex - FRANCE

Tel.: [phone]  Fax: [phone]

Siret N° 348 623 562 00017 - NAF 742 C
Association à but non lucratif enregistrée à la
Sous-Préfecture de Grasse (06) N° 7803/88

Important notice
The present document can be downloaded from:
http://www.etsi.org/standards-search
The present document may be made available in electronic versions and/or in print. The content of any electronic and/or
print versions of the present document shall not be modified without the prior written authorization of ETSI. In case of any
existing or perceived difference in contents between such versions and/or in print, the prevailing version of an ETSI
deliverable is the one made publicly available in PDF format at www.etsi.org/deliver.
Users of the present document should be aware that the document may be subject to revision or change of status.
Information on the current status of this and other ETSI documents is available at
https://portal.etsi.org/TB/ETSIDeliverableStatus.aspx
If you find errors in the present document, please send your comment to one of the following services:
https://portal.etsi.org/People/CommiteeSupportStaff.aspx
Copyright Notification
No part may be reproduced or utilized in any form or by any means, electronic or mechanical, including photocopying
and microfilm except as authorized by written permission of ETSI.
The content of the PDF version shall not be modified without the written authorization of ETSI.
The copyright and the foregoing restriction extend to reproduction in all media.

© ETSI 2020.
All rights reserved.
DECT™, PLUGTESTS™, UMTS™ and the ETSI logo are trademarks of ETSI registered for the benefit of its Members.

3GPP™ and LTE™ are trademarks of ETSI registered for the benefit of its Members and
of the 3GPP Organizational Partners.
oneM2M™ logo is a trademark of ETSI registered for the benefit of its Members and
of the oneM2M Partners. ®
GSM and the GSM logo are trademarks registered and owned by the GSM Association.
ETSI
3GPP TS 29.522 version 15.5.0 Release 15 2 ETSI TS 129 522 V15.5.0 (2020-01)
Intellectual Property Rights
Essential patents
IPRs essential or potentially essential to normative deliverables may have been declared to ETSI. The information
pertaining to these essential IPRs, if any, is publicly available for ETSI members and non-members, and can be found
in ETSI SR 000 314: "Intellectual Property Rights (IPRs); Essential, or potentially Essential, IPRs notified to ETSI in
respect of ETSI standards", which is available from the ETSI Secretariat. Latest updates are available on the ETSI Web
server (https://ipr.etsi.org/).
Pursuant to the ETSI IPR Policy, no investigation, including IPR searches, has been carried out by ETSI. No guarantee
can be given as to the existence of other IPRs not referenced in ETSI SR 000 314 (or the updates on the ETSI Web
server) which are, or may be, or may become, essential to the present document.
Trademarks
The present document may include trademarks and/or tradenames which are asserted and/or registered by their owners.
ETSI claims no ownership of these except for any which are indicated as being the property of ETSI, and conveys no
right to use or reproduce any trademark and/or tradename. Mention of those trademarks in the present document does
not constitute an endorsement by ETSI of products, services or organizations associated with those trademarks.
Legal Notice
This Technical Specification (TS) has been produced by ETSI 3rd Generation Partnership Project (3GPP).
The present document may refer to technical specifications or reports using their 3GPP identities. These shall be
interpreted as being references to the corresponding ETSI deliverables.
The cross reference between 3GPP and ETSI identities can be found under http://webapp.etsi.org/key/queryform.asp.
Modal verbs terminology
In the present document "shall", "shall not", "should", "should not", "may", "need not", "will", "will not", "can" and
"cannot" are to be interpreted as described in clause 3.2 of the ETSI Drafting Rules (Verbal forms for the expression of
provisions).
"must" and "must not" are NOT allowed in ETSI deliverables except when used in direct citation.
ETSI
3GPP TS 29.522 version 15.5.0 Release 15 3 ETSI TS 129 522 V15.5.0 (2020-01)
Contents
Intellectual Property Rights . 2
Legal Notice . 2
Modal verbs terminology . 2
Foreword . 5
1 Scope . 6
2 References . 6
3 Definitions and abbreviations . 7
3.1 Definitions . 7
3.2 Abbreviations . 7
4 NEF Northbound Interface . 7
4.1 Overview . 7
4.2 Reference model . 8
4.3 Functional ele me nts . 9
4.3.1 NEF . 9
4.3.2 AF . 9
4.4 Procedures over NEF Northbound Interface . 9
4.4.1 Introduction. 9
4.4.2 Procedures for Monitoring . 9
4.4.3 Procedures for Device Triggering . 9
4.4.4 Procedures for resource management of Background Data Transfer . 10
4.4.5 Procedures for CP Parameters Provisioning . 10
4.4.6 Procedures for PFD Management . 10
4.4.7 Procedures for Traffic Influence . 10
4.4.7.1 General . 10
4.4.7.2 AF request identified by UE address . 11
4.4.7.3 AF request not identified by UE address. 11
4.4.8 Procedures for changing the chargeable party at session set up or during the session . 12
4.4.9 Procedures for setting up an AF session with required QoS . 12
5 NEF Northbound APIs . 12
5.1 Introduction . 12
5.2 Information applicable to several APIs . 12
5.3 Reused APIs . 13
5.4 TrafficInfluence API . 13
5.4.1 Resources . 13
5.4.1.1 Overview . 13
5.4.1.2 Resource: Traffic Influence Subscription . 14
5.4.1.2.1 Introduction . 14
5.4.1.2.2 Resource Definition . 14
5.4.1.2.3 Resource Methods . 14
5.4.1.2.3.1 General . 14
5.4.1.2.3.2 GET. 14
5.4.1.2.3.3 POST. 15
5.4.1.3 Resource: Individual Traffic Influence Subscription . 15
5.4.1.3.1 Introduction . 15
5.4.1.3.2 Resource Definition . 15
5.4.1.3.3 Resource Methods . 16
5.4.1.3.3.1 General . 16
5.4.1.3.3.2 GET. 16
5.4.1.3.3.3 PUT . 16
5.4.1.3.3.4 PATCH . 17
5.4.1.3.3.5 DELETE . 17
5.4.2 Notifications . 18
5.4.2.1 Introduction . 18
ETSI
3GPP TS 29.522 version 15.5.0 Release 15 4 ETSI TS 129 522 V15.5.0 (2020-01)
5.4.2.2 Event Notification . 18
5.4.2.3 Operation Definition . 18
5.4.2.3.1 Notification via HTTP POST . 18
5.4.2.3.2 Notification via Websocket . 18
5.4.3 Data Model . 19
5.4.3.1 General . 19
5.4.3.2 Reused data types . 19
5.4.3.3 Structured data types . 19
5.4.3.3.1 Introduction . 19
5.4.3.3.2 Type: TrafficInfluSub . 19
5.4.3.3.3 Type: TrafficInfluSubPatch . 22
5.4.3.3.4 Type: EventNotification . 23
5.4.3.4 Simple data types and enumerations . 23
5.4.3.4.1 Introduction . 23
5.4.3.4.2 Simple data types . 24
5.4.3.4.3 Enumeration: SubscribedEvent . 24
5.4.4 Used Features . 24
6 Security. 24
7 Using Common API Framework . 24
7.1 General . 24
7.2 Security . 25
Annex A (normative): OpenAPI representation for NEF Northbound APIs . 26
A.1 General . 26
A.2 TrafficInfluence API . 26
Annex B (informative): Change history . 33
History . 36

ETSI
3GPP TS 29.522 version 15.5.0 Release 15 5 ETSI TS 129 522 V15.5.0 (2020-01)
Foreword
rd
This Technical Specification has been produced by the 3 Generation Partnership Project (3GPP).
The contents of the present document are subject to continuing work within the TSG and may change following formal
TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an
identifying change of release date and an increase in version number as follows:
Version x.y.z
where:
x the first digit:
1 presented to TSG for information;
2 presented to TSG for approval;
3 or greater indicates TSG approved document under change control.
y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections,
updates, etc.
z the third digit is incremented when editorial only changes have been incorporated in the document.
ETSI
3GPP TS 29.522 version 15.5.0 Release 15 6 ETSI TS 129 522 V15.5.0 (2020-01)
1 Scope
The present specification describes the protocol for the NEF Northbound interface between the NEF and the AF. The
NEF Northbound interface and the related stage 2 functional requirements are defined in 3GPP TS 23.502 [2].
2 References
The following documents contain provisions which, through reference in this text, constitute provisions of the present
document.
- References are either specific (identified by date of publication, edition number, version number, etc.) or
non-specific.
- For a specific reference, subsequent revisions do not apply.
- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including
a GSM document), a non-specific reference implicitly refers to the latest version of that document in the same
Release as the present document.
[1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications".
[2] 3GPP TS 23.502: "Procedures for the 5G system".
[3] 3GPP TS 23.501: "System Architecture for the 5G".
[4] 3GPP TS 29.122: "T8 reference point for northbound Application Programming Interfaces
(APIs)".
[5] Open API Initiative, "OpenAPI 3.0.0 Specification", https://github.com/OAI/OpenAPI-
Specification/blob/master/versions/3.0.0.md.
[6] 3GPP TS 33.501: "Security architecture and procedures for 5G System".
[7] 3GPP TS 29.514: "5G System; Policy Authorization Service; Stage 3".
[8] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces; Stage 3".
[9] 3GPP TS 29.521: "5G System; Binding Support Management Service; Stage 3".
[10] Void.
[11] 3GPP TS 23.222: "Common API Framework for 3GPP Northbound APIs; Stage 2".
[12] 3GPP TS 29.222: "Common API Framework for 3GPP Northbound APIs; Stage 3".
[13] IETF RFC 6749: "The OAuth 2.0 Authorization Framework".
[14] 3GPP TS 33.122: "Security Aspects of Common API Framework for 3GPP Northbound APIs".
[15] Void.
[16] IETF RFC 5246: "The Transport Layer Security (TLS) Protocol Version 1.2".
[17] 3GPP TS 29.503: "5G System; Unified Data Management Services; Stage 3".
[18] 3GPP TS 29.518: "5G System; Access and Mobility Management Services; Stage 3".
[19] 3GPP TS 29.554: "5G System; Background Data Transfer Policy Control Service; Stage 3".
[20] 3GPP TS 29.504: "5G System; Unified Data Repository Services; Stage 3".
[21] 3GPP TR 21.900: "Technical Specification Group working methods".
ETSI
3GPP TS 29.522 version 15.5.0 Release 15 7 ETSI TS 129 522 V15.5.0 (2020-01)
3 Definitions and abbreviations
3.1 Definitions
For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following
apply. A term defined in the present document takes precedence over the definition of the same term, if any, in
3GPP TR 21.905 [1].
3.2 Abbreviations
For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An
abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in
3GPP TR 21.905 [1].
AF Application Function
BDT Background Data Transfer
CAPIF Common API Framework
CP Communication Pattern
DN Data Network
DNAI DN Access Identifier
DNN Data Network Name
GPSI Generic Public Subscription Identifier
NEF Network Exposure Function
PCF Policy Control Function
PCRF Policy and Charging Rule Function
PFD Packet Flow Description
PFDF Packet Flow Description Function
REST Representational State Transfer
SCEF Service Capability Exposure Function
S-NSSAI Single Network Slice Selection Assistance Information
UDR Unified Data Repository
UP User Plane
4 NEF Northbound Interface
4.1 Overview
The NEF Northbound interface is between the NEF and the AF. It specifies RESTful APIs that allow the AF to access
the services and capabilities provided by 3GPP network entities and securely exposed by the NEF.
This document also specifies the procedures triggered at the NEF by API requests from the AF and by event
notifications received from 3GPP network entities.
The stage 2 level requirements and signalling flows for the NEF Northbound interface are defined in
3GPP TS 23.502 [2].
The NEF Northbound interface supports the following procedures:
- Procedures for Monitoring
- Procedures for Device Triggering
- Procedures for resource management of Background Data Transfer
- Procedures for CP Parameters Provisioning
- Procedures for PFD Management
ETSI
3GPP TS 29.522 version 15.5.0 Release 15 8 ETSI TS 129 522 V15.5.0 (2020-01)
- Procedures for Traffic Influence
- Procedures for changing the chargeable party at session set up or during the session
- Procedures for setting up an AF session with required QoS
Which correspond to the following services respectively, supported by the NEF as defined in 3GPP TS 23.502 [2]:
- Nnef_EventExposure service
- Nnef_Trigger service
- Nnef_BDTPNegotiation service
- Nnef_ParameterProvision service
- Nnef_PFDManagement service
- Nnef_TrafficInfluence service
- Nnef_ChargeableParty service
- Nnef_AFsessionWithQoS service
NOTE: For Nnef_PFDManagement service, only the Nnef_PFDManagement_Create/Update/Delete service
operations are applicable for the NEF Northbound interface.
4.2 Reference model
The NEF Northbound interface resides between the NEF and the AF as depicted in figure 4.2.1. The overall NEF
architecture is depicted in 3GPP TS 23.502 [2]. An AF can get services from multiple NEFs, and an NEF can provide
service to multiple AFs.
NOTE: The AF can be provided by the third party.
NEF
Nnef
AF
Figure 4.2-1: Reference Architecture for the Nnef Service; SBI representation
NEF AF
N33
Figure 4.2-2: Reference Architecture for the Nnef Service; reference point representation
ETSI
3GPP TS 29.522 version 15.5.0 Release 15 9 ETSI TS 129 522 V15.5.0 (2020-01)
4.3 Functional elements
4.3.1 NEF
The Network Exposure Function (NEF) is a functional element that supports the following functionalities:
- The NEF shall securely expose network capabilities and events provided by 3GPP NFs to AF.
- The NEF shall provide a means for the AF to securely provide information to 3GPP network and may
authenticate, authorize and assist in throttling the AF.
- The NEF shall be able to translate the information received from the AF to the one sent to internal 3GPP NFs,
and vice versa.
- The NEF shall support to expose information (collected from other 3GPP NFs) to the AF.
- The NEF may support a PFD Function which allows the AF to provision PFD(s) and may store and retrieve
PFD(s) in the UDR. The NEF further provisions PFD(s) to the SMF.
A specific NEF instance may support one or more of the functionalities described above and consequently an individual
NEF may support a subset of the APIs specified for capability exposure.
NOTE: The NEF can access the UDR located in the same PLMN as the NEF.
4.3.2 AF
The Application Function (AF) may interact with the 3GPP Core Network via the NEF in order to access network
capabilities.
4.4 Procedures over NEF Northbound Interface
4.4.1 Introduction
All procedures that operate across the NEF Northbound interface, as specified in 3GPP TS 23.502 [2], are specified in
the following subclauses.
4.4.2 Procedures for Monitoring
The procedures for monitoring as described in subclause 4.4.2 of 3GPP TS 29.122 [4] shall be applicable in 5GS with
the following differences:
- description of the SCS/AS applies to the AF;
- description of the SCEF applies to the NEF;
- description of the HSS applies to the UDM, and the NEF shall interact with the UDM by using
Nudm_EventExposure service as defined in 3GPP TS 29.503 [17];
- description of the MME/SGSN applies to the AMF, and the NEF shall interact with the AMF by using
Namf_EventExposure service as defined in 3GPP TS 29.518 [18];
- description about the PCRF is not applicable.
- description about the change of IMSI-IMEI(SV) association monitoring event applies to the change of SUPI-PEI
association monitoring event.
4.4.3 Procedures for Device Triggering
The procedures for device triggering as described in subclause 4.4.6 of 3GPP TS 29.122 [4] shall be applicable in 5G
with the following differences:
ETSI
3GPP TS 29.522 version 15.5.0 Release 15 10 ETSI TS 129 522 V15.5.0 (2020-01)
- description of the SCS/AS applies to the AF;
- description of the SCEF applies to the NEF;
- description of the HSS applies to the UDM;
- the NEF shall interact with the UDM by using the Nudm_SubscriberDataManagement service and the
Nudm_UEContextManagement service as defined in 3GPP TS 29.503 [17]; and
- the NEF acts as MTC-IWF.
4.4.4 Procedures for resource management of Background Data Transfer
The procedures for resource management of Background Data Transfer (BDT) in 5GS are described in subclause 4.4.3
3GPP TS 29.122 [4] with the following differences:
- description of the SCS/AS applies to the AF;
- description of the SCEF applies to the NEF;
- description of the PCRF applies to the PCF; and
- the NEF shall interact with the PCF by using Npcf_BDTPolicyControl service as defined in
3GPP TS 29.554 [19].
4.4.5 Procedures for CP Parameters Provisioning
The procedures for CP parameters provisioning as described in subclause 4.4.9 of 3GPP TS 29.122 [4] shall be
applicable in 5G with the following differences:
- description of the SCS/AS applies to the AF;
- description of the SCEF applies to the NEF;
- description of the HSS applies to the UDM;
- the NEF shall interact with the UDM by using Nudm_ParameterProvision service as defined in
3GPP TS 29.503 [17].
4.4.6 Procedures for PFD Management
The procedures for PFD management as described in subclause 4.4.10 of 3GPP TS 29.122 [4] shall be applicable for
5GS with the following differences:
- description of the SCS/AS applies to the AF;
- description of the SCEF applies to the NEF; and
- the NEF (PFDF) shall interact with the UDR for PFD management by using Nudr_DataRepository service as
defined in 3GPP TS 29.504 [20]. The PFDF is functionality within the NEF.
4.4.7 Procedures for Traffic Influence
4.4.7.1 General
In order to create a resource for the Traffic Influence, the AF shall send an HTTP POST message to the NEF to the
resource "Traffic Influence Subscription", the body of the HTTP POST message may include the AF Service Identifier,
external Group Identifier, external Identifier, any UE Indication, the UE IP address, GPSI, DNN, S-NSSAI, Application
Identifier or traffic filtering information, Subscribed Event, Notification destination address, a list of geographic zone
identifier(s), AF Transaction Identifier, a list of DNAI(s), routing profile ID(s) or N6 traffic routing information,
Indication of application relocation possibility, type of notifications, Temporal and spatial validity conditions. The
Notification destination address shall be included if the Subscribed Event is included in the HTTP request message.
ETSI
3GPP TS 29.522 version 15.5.0 Release 15 11 ETSI TS 129 522 V15.5.0 (2020-01)
In order to update an existing traffic influence subscription, the AF shall send an HTTP PUT or PATCH message to the
resource "Individual Traffic Influence Subscription" requesting to change the traffic influence parameters.
In order to delete an existing traffic influence subscription, the AF shall send an HTTP DELETE message to the NEF to
the resource "Individual Traffic Influence Subscription".
Upon receipt of the HTTP request from the AF, if the AF is authorized, the NEF shall perform the mapping as described
in 3GPP TS 23.501 [3], and then perform as described in subclause 4.4.7.2 if the request is for an individual UE or
perform as described in subclause 4.4.7.3 if the request is for multiple UEs.
If the NEF receives a UP management event notification from the SMF indicating the subscribed event is detected, the
NEF shall send an HTTP POST message including the notified event (e.g. UP path has changed) to the AF.
The AF shall respond with an HTTP response to confirm the notification destination received during creation of the
subscription.
4.4.7.2 AF request identified by UE address
Upon receipt of the above AF request which is for an individual UE identified by IP or Ethernet address, the NEF may
interact with the BSF to retrieve the related PCF information by invoking the Nbsf_Management_Discovery service
operation as described in 3GPP TS 29.521 [9], if the NEF receives an error code from the BSF, the NEF shall not
create, update or delete the resource and shall respond to the SCS/AS with a status code set to 500 Internal Server Error.
After receiving a successful response from the BSF, the NEF shall interact with the PCF by invoking the
Npcf_PolicyAuthorization service as described in 3GPP TS 29.514 [7]. After receiving a successful response from the
PCF, the NEF shall,
- for the HTTP POST request, create a resource "Individual Traffic Influence Subscription" which represents the
traffic influence subscription, addressed by a URI that contains the AF Identifier and an NEF-created
subscription identifier, and shall respond to the AF with a 201 Created status code, including a Location header
field containing the URI for the created resource. The AF shall use the URI received in the Location header in
subsequent requests to the NEF to refer to this traffic influence subscription.
- for the HTTP PUT or PATCH request, update a resource "Individual Traffic Influence Subscription" which
represents the traffic influence subscription, and shall responds to the AF with a 200 OK status code.
- for the HTTP DELETE request, remove all properties of the resource and delete the corresponding active
resource "Individual Traffic Influence Subscription" which represents the traffic influence subscription, then
shall responds to the AF with a 204 No Content status code.
If the NEF receives a response with an error code from the PCF, the NEF shall not create, update or delete the resource
and shall respond to the SCS/AS with a status code set to 500 Internal Server Error.
4.4.7.3 AF request not identified by UE address
For AF request not identified by UE address, it may target an individual UE, a group of UEs or any UE. For an
individual UE identified by GPSI, or a group of UEs identified by External Group Identifier, the NEF shall interact with
the UDM by invoking the Nudm_SubscriberDataManagement service as described in 3GPP TS 29.503 [17] to retrieve
the SUPI or Internal Group Identifier.
The NEF shall interact with the UDR by invoking the Nudr_DataRepository service as described in
3GPP TS 29.504 [20], if the NEF receives an error code from the UDR, the NEF shall not create, update or delete the
resource and shall respond to the SCS/AS with a status code set to 500 Internal Server Error.
After receiving a successful response from the UDR, the NEF shall,
- for the HTTP POST request, create a resource "Individual Traffic Influence Subscription" which represents the
traffic influence subscription, addressed by a URI that contains the AF Identifier and an NEF-created
subscription identifier, and shall respond to the AF with a 201 Created status code, including a Location header
field containing the URI for the created resource. The AF shall use the URI received in the Location header in
subsequent requests to the NEF to refer to this traffic influence subscription.
- for the HTTP PUT or PATCH request, update a resource "Individual Traffic Influence Subscription" which
represents the traffic influence subscription, and shall responds to the AF with a 200 OK status code.
ETSI
3GPP TS 29.522 version 15.5.0 Release 15 12 ETSI TS 129 522 V15.5.0 (2020-01)
- for the HTTP DELETE request, delete the corresponding active resource "Individual Traffic Influence
Subscription" which represents the traffic influence subscription, and shall responds to the AF with a 204 No
Content status code.
4.4.8 Procedures for changing the chargeable party at session set up or
during the session
The procedures for changing the chargeable party at session set up or during the session in 5GS are described in
subclause 4.4.4 of 3GPP TS 29.122 [4] with the following differences:
- description of the SCS/AS applies to the AF;
- description of the SCEF applies to the NEF;
- description of the PCRF applies to the PCF; and
- the NEF may interact with BSF by using Nbsf_Management_Discovery service (as defined in
3GPP TS 29.521 [9]) to retrieve the PCF address; and
- the NEF shall interact with the PCF by using Npcf_PolicyAuthorization service as defined in
3GPP TS 29.514 [7].
4.4.9 Procedures for setting up an AF session with required QoS
The procedures for setting up an AF session with required QoS in 5GS are described in subclause 4.4.13 of
3GPP TS 29.122 [4] with the following differences:
- description of the SCS/AS applies to the AF;
- description of the SCEF applies to the NEF;
- description of the PCRF applies to the PCF; and
- the NEF may interact with BSF by using Nbsf_Management_Discovery service (as defined in
3GPP TS 29.521 [9]) to retrieve the PCF address; and
- the NEF shall interact with the PCF by using Npcf_PolicyAuthorization service as defined in
3GPP TS 29.514 [7].
5 NEF Northbound APIs
5.1 Introduction
The NEF Northbound APIs are a set of APIs defining the related procedures and resources for the interaction between
the NEF and the AF.
5.2 Information applicable to several APIs
The usage of HTTP and content type, as specified in subclauses 5.2.2 and 5.2.3 of 3GPP TS 29.122 [4] respectively,
shall be applicable for NEF Northbound APIs.
The notification, error handling, feature negotiation, HTTP custom headers as specified in subclauses 5.2.5, 5.2.6, 5.2.7,
5.2.8 of 3GPP TS 29.122 [ 4] respectively, shall be applicable for NEF Northbound APIs except that the SCEF is
replaced by the NEF and the SCS/AS is replaced by the AF.
The conventions for Open API specification files as specified in subclause 5.2.10 of 3GPP TS 29.122 [4] shall be
applicable for NEF Northbound APIs.
ETSI
3GPP TS 29.522 version 15.5.0 Release 15 13 ETSI TS 129 522 V15.5.0 (2020-01)
5.3 Reused APIs
This subclause describes the northbound APIs which are applicable for both EPS and 5GS.
Table 5.3.1-1: Reused APIs applicable for both EPS and 5GS
API Name Differences
ResourceManagementOfBdt The "LocBdt_5G" feature as described in subclause 5.4.4 of 3GPP TS 29.122 [4] may
only be supported in 5G.
PfdManagement
MonitoringEvent The "Number_of_UEs_in_an_area_notification_5G" feature as described in
subclause 5.3.4 of 3GPP TS 29.122 [4] may only be supported in 5G.
DeviceTriggering
CpProvisioning The "ExpectedUMT_5G" feature as described in subclause 5.10.4 of
3GPP TS 29.122 [4] may only be supported in 5G.
ChargeableParty - The "EthChgParty_5G" feature as described in subclause 5.5.4 of
3GPP TS 29.122 [4] may only be supported in 5G.
- The events (i.e. LOSS_OF_BEARER, RECOVERY_OF_BEARER and
RELEASE_OF_BEARER) do not apply for 5G.
AsSessionWithQoS - The "EthAsSessionQoS_5G" feature as described in subclause 5.14.4 of
3GPP TS 29.122 [4] may only be supported in 5G.
- The events (i.e. LOSS_OF_BEARER, RECOVERY_OF_BEARER and
RELEASE_OF_BEARER) do not apply for 5G.

5.4 TrafficInfluence API
5.4.1 Resources
5.4.1.1 Overview
This subclause describes the structure for the Resource URIs as shown in figure 5.4.1.1-1 and the resources and HTTP
methods used for the TrafficInfluence API.
{apiRoot}/3gpp-traffic-influence/v1/{afId}
/subscriptions
/{subscriptionId}
Figure 5.4.1.1-1: Resource URI structure of the TrafficInfluence API
Table 5.4.1.1-1 provides an overview of the resources and HTTP methods applicable for the TrafficInfluence API.
ETSI
3GPP TS 29.522 version 15.5.0 Release 15 14 ETSI TS 129 522 V15.5.0 (2020-01)
Table 5.4.1.1-1: Resources and methods overview
Resource name Resource URI HTTP method Description
Read all subscriptions for a
GET
{apiRoot}/3gpp-traffic- given AF
Traffic Influence Subscription
Influence/v1/{afId}/subscriptions Create a new subscription to
POST
traffic influence
Read the subscription to the
GET
traffic influence
Modify all of the properties of
PUT an existing subscription to an
{apiRoot}/3gpp-traffic-
Individual Traffic Influence traffic influence
Influence/v1/{afId}/subscriptions/{s
Subscription Modify part of the properties of
ubscriptionId}
PATCH an existing subscription to an
traffic influence
Delete the subscription to the
DELETE
traffic influence
5.4.1.2 Resource: Traffic Influence Subscription
5.4.1.2.1 Introduction
This resource allows a AF to read all active traffic influence subscribtions for the given AF.
5.4.1.2.2 Resource Definition
Resource URI: {apiRoot}/3gpp-traffic-influence/v1/{afId}/subscriptions
This resource shall support the resource URI variables defined in table 5.4.1.2.2-1.
Table 5.4.1.2.2-1: Resource URI variables for this resource
Name Definition
apiRoot Subclause 5.2.4 of 3GPP TS 29.122 [4].
afId Identifier of the AF of type string.

5.4.1.2.3 Resource Methods
5.4.1.2.3.1 General
The following subclauses specify the resource methods supported by the resource as described in subclause 5.4.1.2.3.
5.4.1.2.3.2 GET
The GET method allows to read all active subscriptions for a given AF. The AF shall initiate the HTTP GET request
message and the NEF shall respond to the message.
This method shall support the URI query parameters specified in table 5.4.1.2.3.2-1.
Table 5.4.1.2.3.2-1: URI query parameters supported by the GET method on this resource
Name Data type P Cardinality Description

N/A
This method shall support the request data structures specified in table 5.4.1.2.3.2-2 and the response data structures and
response codes specified in table 5.4.1.2.3.2-3.
ETSI
3GPP TS 29.522 version 15.5.0 Release 15 15 ETSI TS 129 522 V15.5.0 (2020-01)
Table 5.4.1.2.3.2-2: Data structures supported by the GET Request Body on this resource
Data type P Cardinality Description

N/A
Table 5.4.1.2.3.2-3: Data structures supported by the GET Response Body on this resource
Data type P Cardinality Response Description
codes
array(TrafficInfluS M 0.N 200 OK The subscription information for the AF in the request URI are
ub) returned.
NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 of 3GPP TS 29.122 [4]
also apply.
5.4.1.2.3.3 POST
The POST method creates a new subscription resource to traffic influence subscription for a given AF. The AF shall
initiate the HTTP POST request message and the NEF shall respond to the message. The NEF shall construct the URI
of the created resource.
This method shall support the request data structures specified in table 5.4.1.2.3.3-1 and the response data structures and
response codes specified in table 5.4.1.2.3.3-2.
Table 5.4.1.2.3.3-1: Data structures supported by the POST Request Body on this resource
Data type P Cardinality Description
TrafficInfluSub M 1 Parameters to register a subscription to influencing traffic routing and/or
notification about UP management events with the NEF.

Table 5.4.1.2.3.3-2: Data structures supported by the POST Response Body on this resource
Data type P Cardinality Response Description
codes
TrafficInfluSub M 1 201 The subscription was created successfully.
Created
The URI of the created resource shall be returned in the
"Location" HTTP header.
NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 of
3GPP TS 29.122 [4] also apply.

5.4.1.3 Resource: Individual Traffic Influence Subscription
5.4.1.3.1 Introduction
This resource allows a AF to register a subscription to influencing traffic routing and/or notification about UP
management events with the NEF.
5.4.1.3.2 Resource Definition
Resource URI: {apiRoot}/3gpp-traffic-influence/v1/{afId}/subscriptions/{subscriptionId}
This resource shall support the resource URI variables defined in table 5.4.1.3.2-1.
ETSI
3GPP TS 29.522 version 15.5.0 Release 15 16 ETSI TS 129 522 V15.5.0 (2020-01)
Table 5.4.1.3.2-1: Resource URI variables for this resource
Name Definition
apiRoot Subclause 5.2.4 of 3GPP TS 29.122 [4].
afId Identifier of the AF of type string.
subscriptionId Identifier of the subscription resource of type string.

5.4.1.3.3 Resource Methods
5.4.1.3.3.1 General
The following subclauses specify the resource methods supported by the resource as described in subclause 5.4.1.3.3.
5.4.1.3.3.2 GET
The GET method allows to read the active subscription for a given AF and subscription Id. The AF shall initiate the
HTTP GET request message and theNEF shall respond to the message.
This method shall support the URI query parameters specified in table 5.4.1.3.3.2-1.
Table 5.4.1.3.3.2-1: URI query parameters supported by the GET method on this resource
Name Data type P Cardinality Description

N/A
This method shall support the request data structures specified in table 5.4.1.3.3.2-2 and the response data structures and
response codes specified in table 5.4.1.3.3.2-3.
Table 5.4.1.3.3.2-2: Data structures supported by the GET Request Body on this resource
Data type P Cardinality Description

N/A
Table 5.4.1.3.3.2-3: Data structures supported by the GET Response Body on this resource
Data type P Cardinality Response Description
codes
TrafficInfluSub M 1 200 OK The subscription information for the AF in the request URI are
returned.
NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 of
3GPP TS 29.122 [4] also apply.

5.4.1.3.3.3 PUT
The PUT method modifies an existing subscription resource to update a subscription. The AF shall initiate the HTTP
...